From 72302c7575a851b1009b4b0109bab8d24ec9844e Mon Sep 17 00:00:00 2001 From: Wing-Kam Wong Date: Sat, 15 Apr 2023 16:28:02 +0800 Subject: [PATCH] fix: incorrect swagger.json --- packages/nocodb-nest/src/schema/swagger.json | 124788 ---------------- 1 file changed, 124788 deletions(-) diff --git a/packages/nocodb-nest/src/schema/swagger.json b/packages/nocodb-nest/src/schema/swagger.json index eba75b2cb1..b4e9f6c9c5 100644 --- a/packages/nocodb-nest/src/schema/swagger.json +++ b/packages/nocodb-nest/src/schema/swagger.json @@ -20796,124792 +20796,4 @@ } } } -}{ - "openapi": "3.1.0", - "info": { - "title": "nocodb", - "version": "1.0", - "description": "NocoDB API Documentation" - }, - "x-tagGroups": [ - { - "name": "Auth APIs", - "tags": ["Auth", "API Token"] - }, - { - "name": "Public APIs", - "tags": ["Public"] - }, - { - "name": "Data APIs", - "tags": ["DB Table Row", "DB View Row", "Storage"] - }, - { - "name": "Meta APIs", - "tags": [ - "Base", - "DB Table", - "DB Table Column", - "DB Table Filter", - "DB Table Sort", - "DB Table Webhook", - "DB Table Webhook Filter", - "DB View", - "DB View Column", - "DB View Share", - "Plugin", - "Project", - "Utils" - ] - }, - { - "name": "Organisation APIs", - "tags": ["Org App Settings", "Org License", "Org Tokens", "Org Users"] - } - ], - "servers": [ - { - "url": "http://localhost:8080" - } - ], - "paths": { - "/api/v1/auth/user/signup": { - "post": { - "summary": "Signup", - "operationId": "auth-signup", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "token": { - "type": "string", - "description": "The signed JWT token for information exchange", - "example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbWFpbCI6IndAbm9jb2RiLmNvbSIsImZpcnN0bmFtZSI6bnVsbCwibGFzdG5hbWUiOm51bGwsImlkIjoidXNfYjN4bzJpNDRueDV5OWwiLCJyb2xlcyI6Im9yZy1sZXZlbC1jcmVhdG9yLHN1cGVyIiwidG9rZW5fdmVyc2lvbiI6ImJmMTc3ZGUzYjk3YjAzMjY4YjU0NGZmMjMzNGU5YjFhMGUzYzgxM2NiYzliOTJkYWMwYmM5NTRiNmUzN2ZjMTJjYmFkNDM2NmIwYzExZTdjIiwiaWF0IjoxNjc4MDc4NDMyLCJleHAiOjE2NzgxMTQ0MzJ9.gzwp_svZlbA5PV_eawYV-9UFjZVjniy-tCDce16xrkI" - } - } - }, - "examples": { - "Example 1": { - "value": { - "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbWFpbCI6IndAbm9jb2RiLmNvbSIsImZpcnN0bmFtZSI6bnVsbCwibGFzdG5hbWUiOm51bGwsImlkIjoidXNfYjN4bzJpNDRueDV5OWwiLCJyb2xlcyI6Im9yZy1sZXZlbC1jcmVhdG9yLHN1cGVyIiwidG9rZW5fdmVyc2lvbiI6ImJmMTc3ZGUzYjk3YjAzMjY4YjU0NGZmMjMzNGU5YjFhMGUzYzgxM2NiYzliOTJkYWMwYmM5NTRiNmUzN2ZjMTJjYmFkNDM2NmIwYzExZTdjIiwiaWF0IjoxNjc4MDc4NDMyLCJleHAiOjE2NzgxMTQ0MzJ9.gzwp_svZlbA5PV_eawYV-9UFjZVjniy-tCDce16xrkI" - } - } - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string" - } - } - }, - "examples": { - "Invalid email": { - "value": { - "msg": "Invalid email" - } - }, - "Invalid invite url": { - "value": { - "msg": "Invalid invite url" - } - }, - "Expired invite url": { - "value": { - "msg": "Expired invite url, Please contact super admin to get a new invite url" - } - }, - "User already exist": { - "value": { - "msg": "User already exist" - } - }, - "Invite only signup": { - "value": { - "msg": "Not allowed to signup, contact super admin" - } - } - } - } - } - } - }, - "tags": ["Auth"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SignUpReq" - }, - "examples": { - "Example 1": { - "value": { - "email": "user@example.com", - "password": "password123456789", - "firstname": "Alice", - "lastname": "Smith", - "token": null, - "ignore_subscribe": 0 - } - } - } - } - } - }, - "description": "Create a new user with provided email and password and first user is marked as super admin. " - } - }, - "/api/v1/auth/user/signout": { - "post": { - "summary": "Signout", - "operationId": "auth-signout", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "description": "Success Message", - "example": "Signed out successfully" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "Signed out successfully" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Auth"], - "description": "Clear refresh token from the database and cookie." - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "/api/v1/auth/user/signin": { - "post": { - "summary": "Signin", - "operationId": "auth-signin", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "token": { - "type": "string", - "description": "The signed JWT token for information exchange", - "example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbWFpbCI6IndAbm9jb2RiLmNvbSIsImZpcnN0bmFtZSI6bnVsbCwibGFzdG5hbWUiOm51bGwsImlkIjoidXNfYjN4bzJpNDRueDV5OWwiLCJyb2xlcyI6Im9yZy1sZXZlbC1jcmVhdG9yLHN1cGVyIiwidG9rZW5fdmVyc2lvbiI6ImJmMTc3ZGUzYjk3YjAzMjY4YjU0NGZmMjMzNGU5YjFhMGUzYzgxM2NiYzliOTJkYWMwYmM5NTRiNmUzN2ZjMTJjYmFkNDM2NmIwYzExZTdjIiwiaWF0IjoxNjc4MDc4NDMyLCJleHAiOjE2NzgxMTQ0MzJ9.gzwp_svZlbA5PV_eawYV-9UFjZVjniy-tCDce16xrkI" - } - } - }, - "examples": { - "Example 1": { - "value": { - "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbWFpbCI6IndAbm9jb2RiLmNvbSIsImZpcnN0bmFtZSI6bnVsbCwibGFzdG5hbWUiOm51bGwsImlkIjoidXNfYjN4bzJpNDRueDV5OWwiLCJyb2xlcyI6Im9yZy1sZXZlbC1jcmVhdG9yLHN1cGVyIiwidG9rZW5fdmVyc2lvbiI6ImJmMTc3ZGUzYjk3YjAzMjY4YjU0NGZmMjMzNGU5YjFhMGUzYzgxM2NiYzliOTJkYWMwYmM5NTRiNmUzN2ZjMTJjYmFkNDM2NmIwYzExZTdjIiwiaWF0IjoxNjc4MDc4NDMyLCJleHAiOjE2NzgxMTQ0MzJ9.gzwp_svZlbA5PV_eawYV-9UFjZVjniy-tCDce16xrkI" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Auth"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SignInReq" - }, - "examples": { - "example-1": { - "value": { - "email": "user@example.com", - "password": "Password" - } - } - } - } - } - }, - "description": "Authenticate existing user with their email and password. Successful login will return a JWT access-token. " - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "/api/v1/auth/user/me": { - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "get": { - "summary": "Get User Info", - "operationId": "auth-me", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UserInfo" - }, - "examples": { - "example-1": { - "value": { - "id": "us_8kugj628ebjngs", - "email": "user@example.com", - "email_verified": true, - "firstname": "Alice", - "lastname": "Smith", - "roles": "org-level-viewer" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Auth"], - "description": "Returns authenticated user info", - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id" - }, - "in": "query", - "name": "project_id", - "description": "Pass project id to get project specific roles along with user info" - } - ] - } - }, - "/api/v1/auth/password/forgot": { - "post": { - "summary": "Forget Password", - "operationId": "auth-password-forgot", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "q9s5vh2i34x6c" - }, - "example": "Please check your email to reset the password", - "description": "Success Message" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "Please check your email to reset the password" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Emails user with a reset url.", - "tags": ["Auth"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PasswordForgotReq" - }, - "examples": { - "Example 1": { - "value": { - "email": "user@example.com" - } - } - } - } - }, - "description": "Pass registered user email id in request body" - } - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "/api/v1/auth/password/change": { - "post": { - "summary": "Change Password", - "operationId": "auth-password-change", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "description": "Success Message" - } - } - }, - "examples": { - "Success response": { - "value": { - "msg": "Password has been updated successfully" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Change password of authenticated user with a new one.", - "tags": ["Auth"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PasswordChangeReq" - }, - "examples": { - "example-1": { - "value": { - "currentPassword": "currentPassword", - "newPassword": "newPassword" - } - } - } - } - }, - "description": "Old password need to be passed along with new password for changing password." - } - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "/api/v1/auth/token/validate/{token}": { - "post": { - "summary": "Verify Reset Token", - "operationId": "auth-password-reset-token-validate", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "unxdsok22kg1y" - }, - "example": "Token has been validated successfully", - "description": "Success Message" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "Token has been validated successfully" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Validate password reset url token.", - "tags": ["Auth"], - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "parameters": [ - { - "schema": { - "type": "string", - "format": "uuid", - "example": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11" - }, - "name": "token", - "in": "path", - "required": true, - "description": "Reset Token" - } - ] - }, - "/api/v1/auth/email/validate/{token}": { - "post": { - "summary": "Verify Email", - "operationId": "auth-email-validate", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "u49sbr20s9rgf" - }, - "description": "Success Message", - "example": "Email has been verified successfully" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "Email has been verified successfully" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Api for verifying email where token need to be passed which is shared to user email.", - "tags": ["Auth"], - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "parameters": [ - { - "schema": { - "type": "string", - "format": "uuid", - "example": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11" - }, - "name": "token", - "in": "path", - "required": true, - "description": "Validation Token" - } - ] - }, - "/api/v1/auth/password/reset/{token}": { - "post": { - "summary": "Reset Password", - "operationId": "auth-password-reset", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "2to6ro4121rfx" - }, - "description": "Success Message", - "example": "Password has been reset successfully" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "Password has been reset successfully" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Update user password to new by using reset token.", - "tags": ["Auth"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PasswordResetReq" - }, - "examples": { - "Example 1": { - "value": { - "password": "newpassword" - } - } - } - } - } - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "parameters": [ - { - "schema": { - "type": "string", - "format": "uuid", - "example": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11" - }, - "name": "token", - "in": "path", - "required": true, - "description": "Reset Password Token" - } - ] - }, - "/api/v1/auth/token/refresh": { - "post": { - "summary": "Refresh Token", - "operationId": "auth-token-refresh", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "token": { - "type": "string", - "description": "New access token for user", - "example": "96751db2d53fb834382b682268874a2ea9ee610e4d904e688d1513f11d3c30d62d36d9e05dec0d63" - } - } - }, - "examples": { - "Example 1": { - "value": { - "token": "96751db2d53fb834382b682268874a2ea9ee610e4d904e688d1513f11d3c30d62d36d9e05dec0d63" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Regenerate user refresh token", - "tags": ["Auth"], - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "/api/v1/tokens": { - "get": { - "summary": "List Organisation API Tokens", - "operationId": "org-tokens-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiTokenList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "id": "1", - "fk_user_id": "us_b3xo2i44nx5y9l", - "description": "This API Token is for ABC application", - "token": "DYh540o8hbWpUGdarekECKLdN5OhlgCUWutVJYX2" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "List all organisation API tokens. Access with API tokens will be blocked.", - "tags": ["Org Tokens"], - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "post": { - "summary": "Create Organisation API Token", - "operationId": "org-tokens-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiToken" - }, - "examples": { - "Example 1": { - "value": { - "id": "1", - "fk_user_id": "us_b3xo2i44nx5y9l", - "description": "This API Token is for ABC application", - "token": "DYh540o8hbWpUGdarekECKLdN5OhlgCUWutVJYX2" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiTokenReq" - }, - "examples": { - "Example 1": { - "value": { - "description": "This API token is for ABC application" - } - } - } - } - } - }, - "tags": ["Org Tokens"], - "description": "Creat an organisation API token. Access with API tokens will be blocked." - } - }, - "/api/v1/tokens/{token}": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "token", - "in": "path", - "required": true, - "description": "API Token" - } - ], - "delete": { - "summary": "Delete Organisation API Tokens", - "operationId": "org-tokens-delete", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number", - "example": 1 - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Org Tokens"], - "description": "Delete an organisation API token. Access with API tokens will be blocked.", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/license": { - "get": { - "summary": "Get App License", - "operationId": "org-license-get", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Application license key" - } - } - }, - "examples": { - "Example 1": { - "value": { - "key": "195f7bcc-c3e1-43c5-b23c-8d8127280e7d" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Get the application license key. Exclusive for super admin.", - "tags": ["Org License"], - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "post": { - "summary": "Create App License", - "operationId": "org-license-set", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "wsiywigeb9hjl" - }, - "example": "The license key has been saved" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "The license key has been saved" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/LicenseReq" - }, - "examples": { - "Example 1": { - "value": { - "key": "1234567890" - } - } - } - } - } - }, - "tags": ["Org License"], - "description": "Set the application license key. Exclusive for super admin.", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/app-settings": { - "get": { - "summary": "Get App Settings", - "operationId": "org-app-settings-get", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "invite_only_signup": { - "type": "boolean", - "description": "Status of invite only signup", - "example": true - } - } - }, - "examples": { - "Example 1": { - "value": { - "invite_only_signup": true - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Get the application settings. Exclusive for super admin.", - "tags": ["Org App Settings"], - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "post": { - "summary": "Create App Settings", - "operationId": "org-app-settings-set", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "6qbh8ijtc4tva" - }, - "example": "The app settings have been saved" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "The app settings have been saved" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "invite_only_signup": { - "type": "boolean", - "description": "Status of invite only signup", - "example": true - } - } - }, - "examples": { - "Example 1": { - "value": { - "invite_only_signup": true - } - } - } - } - } - }, - "tags": ["Org App Settings"], - "description": "Update the application settings. Exclusive for super admin.", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/users": { - "get": { - "summary": "List Organisation Users", - "operationId": "org-users-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UserList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "email": "user@example.com", - "email_verified": true, - "firstname": "Alice", - "id": "us_8kugj628ebjngs", - "lastname": "Smith", - "roles": "org-level-viewer" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "List all organisation users. Exclusive for Super Admin. Access with API Tokens will be blocked.", - "tags": ["Org Users"], - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "post": { - "summary": "Create Organisation User", - "operationId": "org-users-add", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "x-examples": { - "Example 1": { - "invite_token": "c22c129f-d947-4030-a838-1b498fce21bb", - "email": "w123@nocodb.com" - } - }, - "properties": { - "invite_token": { - "type": "string", - "description": "Invite Token" - }, - "email": { - "type": "string", - "description": "User email", - "example": "user@example.com" - } - } - }, - "examples": { - "Example 1": { - "value": { - "invite_token": "c22c129f-d947-4030-a838-1b498fce21bb", - "email": "user@example.com" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/OrgUserReq" - }, - "examples": { - "Example 1": { - "value": { - "email": "user@example.com", - "roles": "org-level-creator" - } - } - } - } - } - }, - "tags": ["Org Users"], - "description": "Create an organisation user. Exclusive for Super Admin. Access with API Tokens will be blocked.", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/users/{userId}": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "us_b3xo2i44nx5y9l" - }, - "name": "userId", - "in": "path", - "required": true, - "description": "Unique User ID" - } - ], - "patch": { - "summary": "Update Organisation User", - "operationId": "org-users-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "6oa45bkw7j57j" - }, - "example": "The user has been updated successfully" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "The user has been updated successfully" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Org Users"], - "description": "Update an organisation user by User ID. Exclusive for Super Admin. Access with API Tokens will be blocked.", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/OrgUserReq" - }, - "examples": { - "Example 1": { - "value": { - "email": "user@example.com", - "roles": "org-level-creator" - } - } - } - } - }, - "description": "" - } - }, - "delete": { - "summary": "Delete Organisation User", - "operationId": "org-users-delete", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "buvrqjvv255tf" - }, - "example": "The user has been deleted successfully", - "description": "Sucess Message" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "The user has been deleted successfully" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Org Users"], - "description": "Delete an organisation user by User ID. Exclusive for Super Admin. Access with API Tokens will be blocked." - } - }, - "/api/v1/users/{userId}/resend-invite": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "us_b3xo2i44nx5y9l" - }, - "name": "userId", - "in": "path", - "required": true, - "description": "Unique User ID" - } - ], - "post": { - "summary": "Invite Organisation User", - "operationId": "org-users-resend-invite", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "aixfqd9jfh5pq" - }, - "example": "The invitation has been sent to the target user", - "description": "Success Message" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "The invitation has been sent to the target user" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Org Users"], - "description": "Resend Invitation to a specific user. Exclusive for Super Admin. Access with API Tokens will be blocked.", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/users/{userId}/generate-reset-url": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "us_b3xo2i44nx5y9l" - }, - "name": "userId", - "in": "path", - "required": true, - "description": "Unique User ID" - } - ], - "post": { - "summary": "Generate Organisation User Password Reset Token", - "operationId": "org-users-generate-password-reset-token", - "tags": ["Org Users"], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "reset_password_token": { - "type": "string", - "description": "Password Reset Token for the user" - }, - "reset_password_url": { - "type": "string", - "description": "Password Reset URL for the user" - } - } - }, - "examples": { - "Example 1": { - "value": { - "reset_password_token": "string", - "reset_password_url": "string" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Generate Password Reset Token for Organisation User. Exclusive for Super Admin. Access with API Tokens will be blocked.", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/projects/{projectId}/users": { - "get": { - "summary": "List Project Users", - "operationId": "auth-project-user-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "users": { - "type": "object", - "properties": { - "list": { - "type": "array", - "uniqueItems": true, - "minItems": 1, - "items": { - "$ref": "#/components/schemas/User" - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated" - } - }, - "required": ["list", "pageInfo"] - } - } - }, - "examples": { - "Example 1": { - "value": { - "users": { - "list": [ - { - "email": "user@example.com", - "email_verified": true, - "firstname": "Alice", - "id": "us_8kugj628ebjngs", - "lastname": "Smith", - "roles": "org-level-viewer" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "List all users in the given project.", - "tags": ["Auth"], - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - } - ], - "post": { - "summary": "Create Project User", - "operationId": "auth-project-user-add", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "waau9tvy75zsd" - }, - "description": "Success Message for inviting single email", - "example": "The user has been invited successfully" - }, - "invite_token": { - "type": "string", - "x-stoplight": { - "id": "yx0s35u8ds3p7" - }, - "example": "8354ddba-a769-4d64-8397-eccb2e2b3c06" - }, - "error": { - "type": "array", - "x-stoplight": { - "id": "yhfi6wzhr6zr1" - }, - "items": { - "x-stoplight": { - "id": "ce0hlv3d0f96j" - }, - "type": "object", - "properties": { - "email": { - "type": "string", - "x-stoplight": { - "id": "dgnh01j4lxvl1" - }, - "example": "w@nocodb.com" - }, - "error": { - "type": "string", - "x-stoplight": { - "id": "7dgttqiijg8no" - }, - "example": "" - } - } - } - }, - "email": { - "type": "string", - "x-stoplight": { - "id": "08pqst2q30vot" - }, - "example": "w@nocodb.com" - } - } - }, - "examples": { - "Inviting a user without any errors": { - "value": { - "msg": "The user has been invited successfully" - } - }, - "Inviting a user but invitation email failed to send": { - "value": { - "invite_token": "8354ddba-a769-4d64-8397-eccb2e2b3c06", - "email": "w@nocodb.com" - } - }, - "Inviting multiple users": { - "value": { - "invite_token": "8354ddba-a769-4d64-8397-eccb2e2b3c06", - "error": [ - { - "email": "w@nocodb.com", - "error": "" - } - ] - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProjectUserReq" - }, - "examples": { - "Example 1": { - "value": { - "email": "user@example.com", - "roles": "owner" - } - } - } - } - } - }, - "tags": ["Auth"], - "description": "Create a user and add it to the given project", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/projects/{projectId}/info": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - } - ], - "get": { - "summary": "Get Project info", - "operationId": "project-meta-get", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "Node": { - "type": "string", - "description": "Node version", - "example": "v12.16.1" - }, - "Arch": { - "type": "string", - "description": "Architecture type", - "example": "x64" - }, - "Platform": { - "type": "string", - "description": "Platform type", - "example": "linux" - }, - "Docker": { - "type": "boolean", - "description": "Is docker", - "example": false - }, - "Database": { - "type": "string", - "description": "Database type", - "example": "postgres" - }, - "ProjectOnRootDB": { - "type": "boolean", - "description": "Is project on rootdb", - "example": false - }, - "RootDB": { - "type": "string", - "description": "Root database type", - "example": "postgres" - }, - "PackageVersion": { - "type": "string", - "description": "Package version", - "example": "1.0.0" - } - } - }, - "examples": { - "Example 1": { - "value": { - "Node": "v12.16.1", - "Arch": "x64", - "Platform": "linux", - "Docker": false, - "Database": "postgres", - "ProjectOnRootDB": false, - "RootDB": "postgres", - "PackageVersion": "1.0.0" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Project"], - "description": "Get info such as node version, arch, platform, is docker, rootdb and package version of a given project", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/projects/{projectId}/users/{userId}": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - }, - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "us_b3xo2i44nx5y9l" - }, - "name": "userId", - "in": "path", - "required": true, - "description": "Unique User ID" - } - ], - "patch": { - "summary": "Update Project User", - "operationId": "auth-project-user-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "5a2q8as60daly" - }, - "description": "Success Message", - "example": "The user has been updated successfully" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "The user has been updated successfully" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProjectUserReq" - }, - "examples": { - "Example 1": { - "value": { - "email": "user@example.com", - "roles": "owner" - } - } - } - } - } - }, - "tags": ["Auth"], - "description": "Update a given user in a given project. Exclusive for Super Admin. Access with API Tokens will be blocked.", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "delete": { - "summary": "Delete Project User", - "operationId": "auth-project-user-remove", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "5h7c9lqh5ynve" - }, - "example": "The user has been updated successfully", - "description": "Success Message" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "The user has been updated successfully" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Auth"], - "description": "Delete a given user in a given project. Exclusive for Super Admin. Access with API Tokens will be blocked.", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/projects/{projectId}/visibility-rules": { - "get": { - "summary": "Get UI ACL", - "operationId": "project-model-visibility-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": {} - }, - "examples": { - "Example 1": { - "value": [ - { - "ptn": "nc_09gt___Sheet-1", - "_ptn": "Sheet-1", - "ptype": "table", - "tn": "Sheet-1", - "_tn": "Sheet-1", - "table_meta": null, - "id": "vw_75neroyqdye94k", - "base_id": "ds_eol59jg2l4zwev", - "project_id": "p_63b4q0qengen1x", - "fk_model_id": "md_5mipbdg6ketmv8", - "title": "Sheet-1", - "type": 3, - "is_default": true, - "show_system_fields": null, - "lock_type": "collaborative", - "uuid": "24a6d0bb-e45d-4b1a-bfef-f492d870de9f", - "password": null, - "show": true, - "order": 1, - "created_at": "2023-03-08T10:44:55.253Z", - "updated_at": "2023-03-10T07:18:44.908Z", - "meta": { - "allowCSVDownload": true - }, - "view": { - "fk_view_id": "vw_75neroyqdye94k", - "base_id": "ds_eol59jg2l4zwev", - "project_id": "p_63b4q0qengen1x", - "uuid": null, - "created_at": "2023-03-08T10:44:55.288Z", - "updated_at": "2023-03-08T10:44:55.288Z", - "meta": null, - "row_height": null - }, - "disabled": { - "owner": false, - "creator": false, - "viewer": false, - "editor": false, - "commenter": false, - "guest": false - } - } - ] - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Hide / show views based on user role", - "tags": ["Project"], - "parameters": [ - { - "schema": { - "type": "boolean" - }, - "in": "query", - "name": "includeM2M" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - } - ], - "post": { - "summary": "Create UI ACL", - "operationId": "project-model-visibility-set", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "2txh071wsodys" - }, - "example": "UI ACL has been created successfully" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "UI ACL has been created successfully" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VisibilityRuleReq" - } - } - } - }, - "tags": ["Project"], - "description": "Hide / show views based on user role", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/projects/": { - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "get": { - "summary": "List Projects", - "operationId": "project-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProjectList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "bases": [ - { - "alias": "string", - "config": null, - "created_at": "2023-03-01 14:27:36", - "enabled": true, - "id": "string", - "inflection_column": "camelize", - "inflection_table": "camelize", - "is_meta": true, - "order": 1, - "project_id": "string", - "type": "mysql2", - "updated_at": "2023-03-01 14:27:36" - } - ], - "color": "#24716E", - "created_at": "2023-03-01 14:27:36", - "deleted": true, - "description": "This is my project description", - "id": "p_124hhlkbeasewh", - "is_meta": true, - "meta": {}, - "order": 0, - "prefix": "nc_vm5q__", - "status": "string", - "title": "my-project", - "updated_at": "2023-03-01 14:27:36" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "List all project meta data", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["Project"] - }, - "post": { - "summary": "Create Project", - "operationId": "project-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProjectReq" - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/Project" - }, - { - "type": "object", - "properties": { - "external": { - "type": "boolean", - "default": false, - "description": "If true, the project will us an external database else it will use the root database" - } - } - } - ] - }, - "examples": { - "Example 1": { - "value": { - "bases": [ - { - "alias": "string", - "config": null, - "enabled": true, - "id": "string", - "inflection_column": "camelize", - "inflection_table": "camelize", - "is_meta": true, - "order": 1, - "project_id": "string", - "type": "mysql2", - "updated_at": "2023-03-01 14:27:36" - } - ], - "color": "#24716E", - "created_at": "2023-03-01 14:27:36", - "deleted": true, - "description": "This is my project description", - "id": "p_124hhlkbeasewh", - "is_meta": true, - "meta": {}, - "order": 0, - "prefix": "nc_vm5q__", - "status": "string", - "title": "my-project", - "external": false - } - } - } - } - } - }, - "tags": ["Project"], - "description": "Create a new project", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/projects/{projectId}": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - } - ], - "get": { - "summary": "Get Project", - "operationId": "project-read", - "description": "Get the info of a given project", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["Project"], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Project" - }, - "examples": { - "Example 1": { - "value": { - "bases": [ - { - "alias": "string", - "config": null, - "enabled": true, - "id": "string", - "inflection_column": "camelize", - "inflection_table": "camelize", - "is_meta": true, - "order": 1, - "project_id": "string", - "type": "mysql2", - "updated_at": "2023-03-01 14:27:36" - } - ], - "color": "#24716E", - "created_at": "2023-03-01 14:27:36", - "deleted": true, - "description": "This is my project description", - "id": "p_124hhlkbeasewh", - "is_meta": true, - "meta": {}, - "order": 0, - "prefix": "nc_vm5q__", - "status": "string", - "title": "my-project" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - } - }, - "delete": { - "summary": "Delete Project", - "operationId": "project-delete", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "boolean" - }, - "examples": { - "Example 1": { - "value": true - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Project"], - "description": "Delete the given project", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "patch": { - "summary": "Update Project", - "operationId": "project-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number", - "example": 1 - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Project"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProjectUpdateReq" - }, - "examples": { - "Example 1": { - "value": { - "color": "#24716E", - "meta": null, - "title": "My Project" - } - } - } - } - } - }, - "description": "Update the given project", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/projects/{projectId}/bases/{baseId}": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - }, - { - "schema": { - "type": "string", - "pattern": "ds_j04jmxh5xg10lu" - }, - "name": "baseId", - "in": "path", - "required": true, - "description": "Unique Base ID" - } - ], - "get": { - "summary": "Get Base", - "operationId": "base-read", - "description": "Get the base details of a given project", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["Base"], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Base" - }, - "examples": { - "Example 1": { - "value": { - "alias": null, - "config": "", - "enabled": 1, - "id": "ds_krsappzu9f8vmo", - "inflection_column": "camelize", - "inflection_table": "camelize", - "is_meta": 1, - "meta": null, - "order": 1, - "project_id": "p_01clqvzik3izk6", - "type": "mysql2" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - } - }, - "delete": { - "summary": "Delete Base", - "operationId": "base-delete", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "boolean" - }, - "examples": { - "Example 1": { - "value": true - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Base"], - "description": "Delete the base details of a given project", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "patch": { - "summary": "Update Base", - "operationId": "base-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {} - }, - "examples": { - "Example 1": { - "value": { - "id": "ds_rrplkgy0pq1f3c", - "project_id": "p_63b4q0qengen1x", - "alias": "sakila", - "meta": null, - "is_meta": null, - "type": "mysql2", - "inflection_column": "camelize", - "inflection_table": "camelize", - "created_at": "2023-03-11T10:31:15.341Z", - "updated_at": "2023-03-11T10:32:25.763Z", - "enabled": true, - "order": 2 - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Base"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "examples": { - "Example 1": { - "value": { - "alias": "sakila", - "type": "mysql2", - "config": { - "client": "mysql2", - "connection": { - "host": "localhost", - "port": "3306", - "user": "root", - "password": "password", - "database": "sakila" - } - }, - "inflection_column": "camelize", - "inflection_table": "camelize" - } - } - } - } - } - }, - "description": "Update the base details of a given project", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/projects/{projectId}/bases/": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - } - ], - "get": { - "summary": "List Bases", - "operationId": "base-list", - "description": "Get project base list", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["Base"], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BaseList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "alias": null, - "config": "", - "enabled": 1, - "id": "ds_krsappzu9f8vmo", - "inflection_column": "camelize", - "inflection_table": "camelize", - "is_meta": 1, - "meta": null, - "order": 1, - "project_id": "p_01clqvzik3izk6", - "type": "mysql2" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - } - }, - "post": { - "summary": "Create Base", - "operationId": "base-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Base" - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/Base" - }, - { - "type": "object", - "properties": { - "external": { - "type": "boolean", - "default": false - } - } - } - ] - }, - "examples": { - "Example 1": { - "value": { - "alias": null, - "config": "", - "enabled": 1, - "id": "ds_krsappzu9f8vmo", - "inflection_column": "camelize", - "inflection_table": "camelize", - "is_meta": 1, - "meta": null, - "order": 1, - "project_id": "p_01clqvzik3izk6", - "type": "mysql2", - "external": false - } - } - } - } - } - }, - "tags": ["Base"], - "description": "Create a new base on a given project", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/projects/{projectId}/shared": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - } - ], - "get": { - "summary": "Get Project Shared Base", - "operationId": "project-shared-base-get", - "description": "Get Project Shared Base", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["Project"], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "uuid": { - "type": "string", - "format": "uuid", - "example": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11" - }, - "url": { - "type": "string", - "format": "uri" - }, - "roles": { - "type": "string", - "example": "viewer" - } - } - }, - "examples": { - "Example 1": { - "value": { - "uuid": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11", - "url": "http://example.com", - "roles": "viewer" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - } - }, - "delete": { - "summary": "Delete Project Shared Base", - "operationId": "project-shared-base-disable", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "boolean" - }, - "examples": { - "Example 1": { - "value": true - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Project"], - "description": "Delete Project Shared Base", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "post": { - "summary": "Create Project Shared Base", - "operationId": "project-shared-base-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "uuid": { - "$ref": "#/components/schemas/StringOrNull" - }, - "roles": { - "$ref": "#/components/schemas/StringOrNull" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Project"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SharedBaseReq" - }, - "examples": { - "Example 1": { - "value": { - "roles": "editor", - "password": "password123" - } - } - } - } - } - }, - "description": "Create Project Shared Base", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "patch": { - "summary": "Update Project Shared Base", - "operationId": "project-shared-base-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "uuid": { - "type": "string", - "format": "uuid", - "example": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11" - }, - "url": { - "type": "string", - "format": "uri" - }, - "roles": { - "type": "string", - "example": "viewer" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SharedBaseReq" - }, - "examples": { - "Example 1": { - "value": { - "password": "password123", - "roles": "editor" - } - } - } - } - } - }, - "tags": ["Project"], - "description": "Update Project Shared Base", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/projects/{projectId}/cost": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - } - ], - "get": { - "summary": "Project Cost", - "operationId": "project-cost", - "description": "Calculate the Project Cost", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["Project"], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {} - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "x-internal": true - } - }, - "/api/v1/db/meta/projects/{projectId}/tables": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - } - ], - "post": { - "summary": "Create Table", - "operationId": "db-table-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Table" - }, - "examples": { - "Example 1": { - "value": { - "base_id": "ds_g4ccx6e77h1dmi", - "columns": [ - { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": "CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP", - "clen": null, - "column_name": "updated_at", - "cop": "4", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "timestamp", - "deleted": null, - "dt": "timestamp", - "dtx": "specificType", - "dtxp": "0", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_m4wkaqgqqjzoeh", - "meta": null, - "np": null, - "ns": null, - "order": 4, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 0, - "system": 0, - "title": "UpdatedAt", - "uidt": "DateTime", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": "CURRENT_TIMESTAMP", - "clen": null, - "column_name": "created_at", - "cop": "3", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "timestamp", - "deleted": null, - "dt": "timestamp", - "dtx": "specificType", - "dtxp": "0", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_jpl0qu4gj4rexq", - "meta": null, - "np": null, - "ns": null, - "order": 3, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 0, - "system": 0, - "title": "CreatedAt", - "uidt": "DateTime", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": null, - "clen": "45", - "column_name": "title", - "cop": "2", - "created_at": "2023-03-02 17:04:06", - "csn": "utf8mb4", - "ct": "varchar(45)", - "deleted": null, - "dt": "varchar", - "dtx": "specificType", - "dtxp": "45", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_c5knoi4xs4sfpt", - "meta": null, - "np": null, - "ns": null, - "order": 2, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": 1, - "rqd": 0, - "system": 0, - "title": "Title", - "uidt": "SingleLineText", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - { - "ai": 1, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": null, - "clen": null, - "column_name": "id", - "cop": "1", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "int unsigned", - "deleted": null, - "dt": "int", - "dtx": "specificType", - "dtxp": "", - "dtxs": "0", - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_phvuuwjrzcdo0g", - "meta": null, - "np": "10", - "ns": "0", - "order": 1, - "pk": 1, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 1, - "system": 0, - "title": "Id", - "uidt": "ID", - "un": 1, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - } - ], - "columnsById": { - "cl_c5knoi4xs4sfpt": { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": null, - "clen": "45", - "column_name": "title", - "cop": "2", - "created_at": "2023-03-02 17:04:06", - "csn": "utf8mb4", - "ct": "varchar(45)", - "deleted": null, - "dt": "varchar", - "dtx": "specificType", - "dtxp": "45", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_c5knoi4xs4sfpt", - "meta": null, - "np": null, - "ns": null, - "order": 2, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": 1, - "rqd": 0, - "system": 0, - "title": "Title", - "uidt": "SingleLineText", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - "cl_jpl0qu4gj4rexq": { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": "CURRENT_TIMESTAMP", - "clen": null, - "column_name": "created_at", - "cop": "3", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "timestamp", - "deleted": null, - "dt": "timestamp", - "dtx": "specificType", - "dtxp": "0", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_jpl0qu4gj4rexq", - "meta": null, - "np": null, - "ns": null, - "order": 3, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 0, - "system": 0, - "title": "CreatedAt", - "uidt": "DateTime", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - "cl_m4wkaqgqqjzoeh": { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": "CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP", - "clen": null, - "column_name": "updated_at", - "cop": "4", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "timestamp", - "deleted": null, - "dt": "timestamp", - "dtx": "specificType", - "dtxp": "0", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_m4wkaqgqqjzoeh", - "meta": null, - "np": null, - "ns": null, - "order": 4, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 0, - "system": 0, - "title": "UpdatedAt", - "uidt": "DateTime", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - "cl_phvuuwjrzcdo0g": { - "ai": 1, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": null, - "clen": null, - "column_name": "id", - "cop": "1", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "int unsigned", - "deleted": null, - "dt": "int", - "dtx": "specificType", - "dtxp": "", - "dtxs": "0", - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_phvuuwjrzcdo0g", - "meta": null, - "np": "10", - "ns": "0", - "order": 1, - "pk": 1, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 1, - "system": 0, - "title": "Id", - "uidt": "ID", - "un": 1, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - } - }, - "created_at": "2023-03-02 17:04:06", - "deleted": null, - "enabled": 1, - "id": "md_rsu68aqjsbyqtl", - "meta": null, - "mm": 0, - "order": 1, - "pinned": null, - "project_id": "p_xm3thidrblw4n7", - "schema": null, - "table_name": "nc_vm5q___Table1", - "tags": null, - "title": "Table1", - "type": "table", - "updated_at": "2023-03-02 17:04:08", - "views": [ - { - "_ptn": "Table1", - "_tn": "Table1", - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:04:06", - "disabled": { - "commenter": false, - "creator": false, - "editor": false, - "guest": false, - "owner": false, - "viewer": false - }, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "vw_p2jcatxz4mvcfw", - "is_default": 1, - "lock_type": "collaborative", - "meta": {}, - "order": 1, - "password": null, - "project_id": "p_xm3thidrblw4n7", - "ptn": "nc_vm5q___Table1", - "ptype": "table", - "show": 1, - "show_system_fields": null, - "table_meta": null, - "title": "Table1", - "tn": "Table1", - "type": 3, - "updated_at": "2023-03-02 17:04:06", - "uuid": null, - "view": { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:04:06", - "fk_view_id": "vw_p2jcatxz4mvcfw", - "meta": null, - "project_id": "p_xm3thidrblw4n7", - "row_height": null, - "updated_at": "2023-03-02 17:04:06", - "uuid": null - } - } - ] - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TableReq" - } - } - } - }, - "tags": ["DB Table"], - "description": "Create a new table in a given project", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "get": { - "summary": "List Tables", - "operationId": "db-table-list", - "responses": { - "200": { - "$ref": "#/components/responses/TableList" - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - }, - { - "schema": { - "type": "number" - }, - "in": "query", - "name": "page" - }, - { - "schema": { - "type": "number" - }, - "in": "query", - "name": "pageSize" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "sort" - }, - { - "schema": { - "type": "boolean" - }, - "in": "query", - "name": "includeM2M" - } - ], - "tags": ["DB Table"], - "description": "List all tables in a given project" - } - }, - "/api/v1/db/meta/tables/{tableId}": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "md_w9gpnaousnfss1", - "type": "string" - }, - "name": "tableId", - "in": "path", - "required": true, - "description": "Unique Table ID" - } - ], - "get": { - "summary": "Read Table", - "operationId": "db-table-read", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Table" - }, - "examples": { - "Example 1": { - "value": { - "id": "md_rsu68aqjsbyqtl", - "base_id": "ds_g4ccx6e77h1dmi", - "project_id": "p_xm3thidrblw4n7", - "table_name": "nc_vm5q___Table1", - "title": "Table1", - "type": "table", - "meta": null, - "schema": null, - "enabled": 1, - "mm": 0, - "tags": null, - "pinned": null, - "deleted": null, - "order": 1, - "created_at": "2023-03-02 17:04:06", - "updated_at": "2023-03-02 17:04:08", - "columns": [ - { - "id": "cl_phvuuwjrzcdo0g", - "base_id": "ds_g4ccx6e77h1dmi", - "project_id": "p_xm3thidrblw4n7", - "fk_model_id": "md_rsu68aqjsbyqtl", - "title": "Id", - "column_name": "id", - "uidt": "ID", - "dt": "int", - "np": "10", - "ns": "0", - "clen": null, - "cop": "1", - "pk": 1, - "pv": null, - "rqd": 1, - "un": 1, - "ct": "int unsigned", - "ai": 1, - "unique": 0, - "cdf": null, - "cc": "", - "csn": null, - "dtx": "specificType", - "dtxp": "", - "dtxs": "0", - "au": 0, - "validate": null, - "virtual": null, - "deleted": null, - "system": 0, - "order": 1, - "created_at": "2023-03-02 17:04:06", - "updated_at": "2023-03-02 17:04:06", - "meta": null - }, - { - "id": "cl_c5knoi4xs4sfpt", - "base_id": "ds_g4ccx6e77h1dmi", - "project_id": "p_xm3thidrblw4n7", - "fk_model_id": "md_rsu68aqjsbyqtl", - "title": "Title", - "column_name": "title", - "uidt": "SingleLineText", - "dt": "varchar", - "np": null, - "ns": null, - "clen": "45", - "cop": "2", - "pk": 0, - "pv": 1, - "rqd": 0, - "un": 0, - "ct": "varchar(45)", - "ai": 0, - "unique": 0, - "cdf": null, - "cc": "", - "csn": "utf8mb4", - "dtx": "specificType", - "dtxp": "45", - "dtxs": null, - "au": 0, - "validate": null, - "virtual": null, - "deleted": null, - "system": 0, - "order": 2, - "created_at": "2023-03-02 17:04:06", - "updated_at": "2023-03-02 17:04:06", - "meta": null - }, - { - "id": "cl_jpl0qu4gj4rexq", - "base_id": "ds_g4ccx6e77h1dmi", - "project_id": "p_xm3thidrblw4n7", - "fk_model_id": "md_rsu68aqjsbyqtl", - "title": "CreatedAt", - "column_name": "created_at", - "uidt": "DateTime", - "dt": "timestamp", - "np": null, - "ns": null, - "clen": null, - "cop": "3", - "pk": 0, - "pv": null, - "rqd": 0, - "un": 0, - "ct": "timestamp", - "ai": 0, - "unique": 0, - "cdf": "CURRENT_TIMESTAMP", - "cc": "", - "csn": null, - "dtx": "specificType", - "dtxp": "0", - "dtxs": null, - "au": 0, - "validate": null, - "virtual": null, - "deleted": null, - "system": 0, - "order": 3, - "created_at": "2023-03-02 17:04:06", - "updated_at": "2023-03-02 17:04:06", - "meta": null - }, - { - "id": "cl_m4wkaqgqqjzoeh", - "base_id": "ds_g4ccx6e77h1dmi", - "project_id": "p_xm3thidrblw4n7", - "fk_model_id": "md_rsu68aqjsbyqtl", - "title": "UpdatedAt", - "column_name": "updated_at", - "uidt": "DateTime", - "dt": "timestamp", - "np": null, - "ns": null, - "clen": null, - "cop": "4", - "pk": 0, - "pv": null, - "rqd": 0, - "un": 0, - "ct": "timestamp", - "ai": 0, - "unique": 0, - "cdf": "CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP", - "cc": "", - "csn": null, - "dtx": "specificType", - "dtxp": "0", - "dtxs": null, - "au": 0, - "validate": null, - "virtual": null, - "deleted": null, - "system": 0, - "order": 4, - "created_at": "2023-03-02 17:04:06", - "updated_at": "2023-03-02 17:04:06", - "meta": null - } - ], - "views": [ - { - "ptn": "nc_vm5q___Table1", - "_ptn": "Table1", - "ptype": "table", - "tn": "Table1", - "_tn": "Table1", - "table_meta": null, - "id": "vw_p2jcatxz4mvcfw", - "base_id": "ds_g4ccx6e77h1dmi", - "project_id": "p_xm3thidrblw4n7", - "fk_model_id": "md_rsu68aqjsbyqtl", - "title": "Table1", - "type": 3, - "is_default": 1, - "show_system_fields": null, - "lock_type": "collaborative", - "uuid": null, - "password": null, - "show": 1, - "order": 1, - "created_at": "2023-03-02 17:04:06", - "updated_at": "2023-03-02 17:04:06", - "meta": {}, - "view": { - "fk_view_id": "vw_p2jcatxz4mvcfw", - "base_id": "ds_g4ccx6e77h1dmi", - "project_id": "p_xm3thidrblw4n7", - "uuid": null, - "created_at": "2023-03-02 17:04:06", - "updated_at": "2023-03-02 17:04:06", - "meta": null, - "row_height": null - }, - "disabled": { - "owner": false, - "creator": false, - "viewer": false, - "editor": false, - "commenter": false, - "guest": false - } - } - ], - "columnsById": { - "cl_phvuuwjrzcdo0g": { - "id": "cl_phvuuwjrzcdo0g", - "base_id": "ds_g4ccx6e77h1dmi", - "project_id": "p_xm3thidrblw4n7", - "fk_model_id": "md_rsu68aqjsbyqtl", - "title": "Id", - "column_name": "id", - "uidt": "ID", - "dt": "int", - "np": "10", - "ns": "0", - "clen": null, - "cop": "1", - "pk": 1, - "pv": null, - "rqd": 1, - "un": 1, - "ct": "int unsigned", - "ai": 1, - "unique": 0, - "cdf": null, - "cc": "", - "csn": null, - "dtx": "specificType", - "dtxp": "", - "dtxs": "0", - "au": 0, - "validate": null, - "virtual": null, - "deleted": null, - "system": 0, - "order": 1, - "created_at": "2023-03-02 17:04:06", - "updated_at": "2023-03-02 17:04:06", - "meta": null - }, - "cl_c5knoi4xs4sfpt": { - "id": "cl_c5knoi4xs4sfpt", - "base_id": "ds_g4ccx6e77h1dmi", - "project_id": "p_xm3thidrblw4n7", - "fk_model_id": "md_rsu68aqjsbyqtl", - "title": "Title", - "column_name": "title", - "uidt": "SingleLineText", - "dt": "varchar", - "np": null, - "ns": null, - "clen": "45", - "cop": "2", - "pk": 0, - "pv": 1, - "rqd": 0, - "un": 0, - "ct": "varchar(45)", - "ai": 0, - "unique": 0, - "cdf": null, - "cc": "", - "csn": "utf8mb4", - "dtx": "specificType", - "dtxp": "45", - "dtxs": null, - "au": 0, - "validate": null, - "virtual": null, - "deleted": null, - "system": 0, - "order": 2, - "created_at": "2023-03-02 17:04:06", - "updated_at": "2023-03-02 17:04:06", - "meta": null - }, - "cl_jpl0qu4gj4rexq": { - "id": "cl_jpl0qu4gj4rexq", - "base_id": "ds_g4ccx6e77h1dmi", - "project_id": "p_xm3thidrblw4n7", - "fk_model_id": "md_rsu68aqjsbyqtl", - "title": "CreatedAt", - "column_name": "created_at", - "uidt": "DateTime", - "dt": "timestamp", - "np": null, - "ns": null, - "clen": null, - "cop": "3", - "pk": 0, - "pv": null, - "rqd": 0, - "un": 0, - "ct": "timestamp", - "ai": 0, - "unique": 0, - "cdf": "CURRENT_TIMESTAMP", - "cc": "", - "csn": null, - "dtx": "specificType", - "dtxp": "0", - "dtxs": null, - "au": 0, - "validate": null, - "virtual": null, - "deleted": null, - "system": 0, - "order": 3, - "created_at": "2023-03-02 17:04:06", - "updated_at": "2023-03-02 17:04:06", - "meta": null - }, - "cl_m4wkaqgqqjzoeh": { - "id": "cl_m4wkaqgqqjzoeh", - "base_id": "ds_g4ccx6e77h1dmi", - "project_id": "p_xm3thidrblw4n7", - "fk_model_id": "md_rsu68aqjsbyqtl", - "title": "UpdatedAt", - "column_name": "updated_at", - "uidt": "DateTime", - "dt": "timestamp", - "np": null, - "ns": null, - "clen": null, - "cop": "4", - "pk": 0, - "pv": null, - "rqd": 0, - "un": 0, - "ct": "timestamp", - "ai": 0, - "unique": 0, - "cdf": "CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP", - "cc": "", - "csn": null, - "dtx": "specificType", - "dtxp": "0", - "dtxs": null, - "au": 0, - "validate": null, - "virtual": null, - "deleted": null, - "system": 0, - "order": 4, - "created_at": "2023-03-02 17:04:06", - "updated_at": "2023-03-02 17:04:06", - "meta": null - } - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table"], - "description": "Read the table meta data by the given table ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "patch": { - "summary": "Update Table", - "operationId": "db-table-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "5a0g9yvs4e678" - }, - "example": "The table has been updated successfully" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "The table has been updated successfully" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "table_name": { - "type": "string", - "description": "Table name", - "example": "users" - }, - "title": { - "type": "string", - "description": "Table title", - "example": "Users" - }, - "project_id": { - "type": "string", - "description": "Project ID", - "example": "p_124hhlkbeasewh" - }, - "meta": { - "$ref": "#/components/schemas/Meta" - } - } - }, - "examples": { - "Example 1": { - "value": { - "table_name": "users", - "title": "Users", - "project_id": "p_124hhlkbeasewh", - "meta": null - } - } - } - } - } - }, - "description": "Update the table meta data by the given table ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "delete": { - "summary": "Delete Table", - "operationId": "db-table-delete", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "boolean" - }, - "examples": { - "Example 1": { - "value": true - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table"], - "description": "Delete the table meta data by the given table ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/projects/{projectId}/{baseId}/tables": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - }, - { - "schema": { - "type": "string", - "pattern": "ds_j04jmxh5xg10lu" - }, - "name": "baseId", - "in": "path", - "required": true, - "description": "Unique Base ID" - } - ], - "get": { - "summary": "List Tables", - "operationId": "table-list", - "responses": { - "200": { - "$ref": "#/components/responses/TableList" - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - }, - { - "schema": { - "type": "number" - }, - "in": "query", - "name": "page" - }, - { - "schema": { - "type": "number" - }, - "in": "query", - "name": "pageSize" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "sort" - }, - { - "schema": { - "type": "boolean" - }, - "in": "query", - "name": "includeM2M" - } - ], - "tags": ["Base"], - "description": "List all tables in a given Project and Base" - }, - "post": { - "summary": "Create Table", - "operationId": "table-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Table" - }, - "examples": { - "Example 1": { - "value": { - "base_id": "ds_g4ccx6e77h1dmi", - "columns": [ - { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": "CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP", - "clen": null, - "column_name": "updated_at", - "cop": "4", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "timestamp", - "deleted": null, - "dt": "timestamp", - "dtx": "specificType", - "dtxp": "0", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_m4wkaqgqqjzoeh", - "meta": null, - "np": null, - "ns": null, - "order": 4, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 0, - "system": 0, - "title": "UpdatedAt", - "uidt": "DateTime", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": "CURRENT_TIMESTAMP", - "clen": null, - "column_name": "created_at", - "cop": "3", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "timestamp", - "deleted": null, - "dt": "timestamp", - "dtx": "specificType", - "dtxp": "0", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_jpl0qu4gj4rexq", - "meta": null, - "np": null, - "ns": null, - "order": 3, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 0, - "system": 0, - "title": "CreatedAt", - "uidt": "DateTime", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": null, - "clen": "45", - "column_name": "title", - "cop": "2", - "created_at": "2023-03-02 17:04:06", - "csn": "utf8mb4", - "ct": "varchar(45)", - "deleted": null, - "dt": "varchar", - "dtx": "specificType", - "dtxp": "45", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_c5knoi4xs4sfpt", - "meta": null, - "np": null, - "ns": null, - "order": 2, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": 1, - "rqd": 0, - "system": 0, - "title": "Title", - "uidt": "SingleLineText", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - { - "ai": 1, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": null, - "clen": null, - "column_name": "id", - "cop": "1", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "int unsigned", - "deleted": null, - "dt": "int", - "dtx": "specificType", - "dtxp": "", - "dtxs": "0", - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_phvuuwjrzcdo0g", - "meta": null, - "np": "10", - "ns": "0", - "order": 1, - "pk": 1, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 1, - "system": 0, - "title": "Id", - "uidt": "ID", - "un": 1, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - } - ], - "columnsById": { - "cl_c5knoi4xs4sfpt": { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": null, - "clen": "45", - "column_name": "title", - "cop": "2", - "created_at": "2023-03-02 17:04:06", - "csn": "utf8mb4", - "ct": "varchar(45)", - "deleted": null, - "dt": "varchar", - "dtx": "specificType", - "dtxp": "45", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_c5knoi4xs4sfpt", - "meta": null, - "np": null, - "ns": null, - "order": 2, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": 1, - "rqd": 0, - "system": 0, - "title": "Title", - "uidt": "SingleLineText", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - "cl_jpl0qu4gj4rexq": { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": "CURRENT_TIMESTAMP", - "clen": null, - "column_name": "created_at", - "cop": "3", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "timestamp", - "deleted": null, - "dt": "timestamp", - "dtx": "specificType", - "dtxp": "0", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_jpl0qu4gj4rexq", - "meta": null, - "np": null, - "ns": null, - "order": 3, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 0, - "system": 0, - "title": "CreatedAt", - "uidt": "DateTime", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - "cl_m4wkaqgqqjzoeh": { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": "CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP", - "clen": null, - "column_name": "updated_at", - "cop": "4", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "timestamp", - "deleted": null, - "dt": "timestamp", - "dtx": "specificType", - "dtxp": "0", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_m4wkaqgqqjzoeh", - "meta": null, - "np": null, - "ns": null, - "order": 4, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 0, - "system": 0, - "title": "UpdatedAt", - "uidt": "DateTime", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - "cl_phvuuwjrzcdo0g": { - "ai": 1, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": null, - "clen": null, - "column_name": "id", - "cop": "1", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "int unsigned", - "deleted": null, - "dt": "int", - "dtx": "specificType", - "dtxp": "", - "dtxs": "0", - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_phvuuwjrzcdo0g", - "meta": null, - "np": "10", - "ns": "0", - "order": 1, - "pk": 1, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 1, - "system": 0, - "title": "Id", - "uidt": "ID", - "un": 1, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - } - }, - "created_at": "2023-03-02 17:04:06", - "deleted": null, - "enabled": 1, - "id": "md_rsu68aqjsbyqtl", - "meta": null, - "mm": 0, - "order": 1, - "pinned": null, - "project_id": "p_xm3thidrblw4n7", - "schema": null, - "table_name": "nc_vm5q___Table1", - "tags": null, - "title": "Table1", - "type": "table", - "updated_at": "2023-03-02 17:04:08", - "views": [ - { - "_ptn": "Table1", - "_tn": "Table1", - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:04:06", - "disabled": { - "commenter": false, - "creator": false, - "editor": false, - "guest": false, - "owner": false, - "viewer": false - }, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "vw_p2jcatxz4mvcfw", - "is_default": 1, - "lock_type": "collaborative", - "meta": {}, - "order": 1, - "password": null, - "project_id": "p_xm3thidrblw4n7", - "ptn": "nc_vm5q___Table1", - "ptype": "table", - "show": 1, - "show_system_fields": null, - "table_meta": null, - "title": "Table1", - "tn": "Table1", - "type": 3, - "updated_at": "2023-03-02 17:04:06", - "uuid": null, - "view": { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:04:06", - "fk_view_id": "vw_p2jcatxz4mvcfw", - "meta": null, - "project_id": "p_xm3thidrblw4n7", - "row_height": null, - "updated_at": "2023-03-02 17:04:06", - "uuid": null - } - } - ] - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TableReq" - }, - "examples": { - "Example 1": { - "value": { - "columns": [ - { - "ai": false, - "altered": 1, - "cdf": "CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP", - "ck": false, - "clen": 45, - "column_name": "updated_at", - "ct": "varchar(45)", - "dt": "timestamp", - "dtx": "specificType", - "dtxp": "", - "dtxs": "", - "np": null, - "nrqd": true, - "ns": null, - "pk": false, - "rqd": false, - "title": "UpdatedAt", - "uicn": "", - "uidt": "DateTime", - "uip": "", - "un": false - }, - { - "ai": false, - "altered": 1, - "cdf": "CURRENT_TIMESTAMP", - "ck": false, - "clen": 45, - "column_name": "created_at", - "ct": "varchar(45)", - "dt": "timestamp", - "dtx": "specificType", - "dtxp": "", - "dtxs": "", - "np": null, - "nrqd": true, - "ns": null, - "pk": false, - "rqd": false, - "title": "CreatedAt", - "uicn": "", - "uidt": "DateTime", - "uip": "", - "un": false - }, - { - "ai": false, - "altered": 1, - "cdf": null, - "ck": false, - "clen": 45, - "column_name": "title", - "ct": "varchar(45)", - "dt": "varchar", - "dtx": "specificType", - "dtxp": "45", - "dtxs": "", - "np": null, - "nrqd": true, - "ns": null, - "pk": false, - "rqd": false, - "title": "Title", - "uicn": "", - "uidt": "SingleLineText", - "uip": "", - "un": false - }, - { - "ai": true, - "altered": 1, - "cdf": null, - "ck": false, - "clen": null, - "column_name": "id", - "ct": "int(11)", - "dt": "int", - "dtx": "integer", - "dtxp": "11", - "dtxs": "", - "np": 11, - "nrqd": false, - "ns": 0, - "pk": true, - "rqd": true, - "title": "Id", - "uicn": "", - "uidt": "ID", - "uip": "", - "un": true - } - ], - "table_name": "Sheet-1", - "title": "Sheet-1" - } - } - } - } - } - }, - "tags": ["Base"], - "description": "Create a new table in a given Project and Base", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/tables/{tableId}/reorder": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "md_w9gpnaousnfss1", - "type": "string" - }, - "name": "tableId", - "in": "path", - "required": true, - "description": "Unique Table ID" - } - ], - "post": { - "summary": "Reorder Table", - "operationId": "db-table-reorder", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "boolean" - }, - "examples": { - "Example 1": { - "value": true - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "order": { - "type": "number" - } - } - }, - "examples": { - "Example 1": { - "value": { - "order": 0 - } - } - } - } - } - }, - "tags": ["DB Table"], - "description": "Update the order of the given Table", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/tables/{tableId}/columns": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "md_w9gpnaousnfss1", - "type": "string" - }, - "name": "tableId", - "in": "path", - "required": true, - "description": "Unique Table ID" - } - ], - "post": { - "summary": "Create Column", - "operationId": "db-table-column-create", - "responses": { - "200": { - "description": "OK" - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ColumnReq" - }, - "examples": { - "Example 1": { - "value": { - "ai": 0, - "au": 0, - "base_id": "ds_krsappzu9f8vmo", - "cc": "", - "cdf": null, - "clen": "45", - "column_name": "title", - "cop": "2", - "csn": "utf8mb4", - "ct": "varchar(45)", - "deleted": null, - "dt": "varchar", - "dtx": "specificType", - "dtxp": "45", - "dtxs": null, - "fk_model_id": "md_yvwvbt2i78rgcm", - "id": "cl_0j9gv0oi8vjy46", - "meta": null, - "np": null, - "ns": null, - "order": 2, - "pk": 0, - "project_id": "p_01clqvzik3izk6", - "pv": 1, - "rqd": 0, - "system": 0, - "title": "Title", - "uidt": "SingleLineText", - "un": 0, - "unique": 0, - "validate": null, - "virtual": null - } - } - } - } - } - }, - "tags": ["DB Table Column"], - "description": "Create a new column in a given Table", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/columns/{columnId}": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "columnId", - "in": "path", - "required": true - } - ], - "patch": { - "summary": "Update Column", - "operationId": "db-table-column-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Column" - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ColumnReq" - } - } - } - }, - "tags": ["DB Table Column"], - "description": "Update the existing column by the given column ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "delete": { - "summary": "Delete Column", - "operationId": "db-table-column-delete", - "responses": { - "200": { - "description": "OK" - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Column"], - "description": "Delete the existing column by the given column ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "get": { - "summary": "Get Column", - "operationId": "db-table-column-get", - "responses": { - "200": { - "description": "OK" - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Column"], - "description": "Get the existing column by the given column ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/columns/{columnId}/primary": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "columnId", - "in": "path", - "required": true - } - ], - "post": { - "summary": "Create Primary Value", - "operationId": "db-table-column-primary-column-set", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "boolean" - }, - "examples": { - "Example 1": { - "value": true - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Column"], - "description": "Set a primary value on a given column", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/tables/{tableId}/views": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "md_w9gpnaousnfss1", - "type": "string" - }, - "name": "tableId", - "in": "path", - "required": true, - "description": "Unique Table ID" - } - ], - "get": { - "summary": "List Views", - "operationId": "db-view-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ViewList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "alias": "string", - "column": [ - { - "alias": "string", - "auto_increment": true, - "auto_update_timestamp": true, - "base_id": "string", - "character_maximum_length": "string", - "character_set_name": "string", - "colOptions": { - "deleted": "string", - "dr": "string", - "fk_child_column_id": "string", - "fk_column_id": "string", - "fk_index_name": "string", - "fk_mm_child_column_id": "string", - "fk_mm_model_id": "string", - "fk_mm_parent_column_id": "string", - "fk_parent_column_id": "string", - "id": "string", - "order": "string", - "type": "string", - "ur": "string", - "virtual": true - }, - "column_comment": "string", - "column_default": "string", - "column_ordinal_position": "string", - "column_type": "string", - "data_type": "string", - "data_type_x": "string", - "data_type_x_precision": "string", - "data_type_x_scale": "string", - "deleted": true, - "fk_model_id": "string", - "id": "string", - "numeric_precision": "string", - "numeric_scale": "string", - "order": 0, - "primary_key": true, - "primary_value": true, - "rqd": "string", - "title": "string", - "ui_data_type": "string", - "un": "string", - "unique": true, - "visible": true - } - ], - "columnByIds": {}, - "deleted": true, - "enabled": true, - "fk_base_id": "string", - "fk_project_id": "string", - "id": "string", - "order": 0, - "parent_id": "string", - "pinned": true, - "show_as": "string", - "tags": "string", - "title": "string", - "type": "string" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "description": "List all views in a given Table.", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/views/{viewId}": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "vw_wtdg2meyig5l4q" - }, - "name": "viewId", - "in": "path", - "required": true, - "description": "Unique View ID" - } - ], - "patch": { - "summary": "Update View", - "operationId": "db-view-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/View" - }, - "examples": { - "Example 1": { - "value": { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:46:31", - "fk_model_id": "md_mhs9z4r2ak98x0", - "id": "vw_lg052cnc1c26kf", - "is_default": 1, - "lock_type": "collaborative", - "meta": "{\"allowCSVDownload\":true}", - "order": 1, - "password": "password123", - "project_id": "p_xm3thidrblw4n7", - "show": 1, - "show_system_fields": null, - "title": "Grid View 1", - "type": 3, - "updated_at": "2023-03-02 17:46:31", - "uuid": null - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ViewUpdateReq" - }, - "examples": { - "Example 1": { - "value": { - "title": "Grid View 1", - "uuid": "e2457bbf-e29c-4fec-866e-fe3b01dba57f", - "password": "password123", - "lock_type": "collaborative", - "meta": "{\"allowCSVDownload\":true}", - "order": 1, - "show_system_fields": 0 - } - } - } - } - } - }, - "tags": ["DB View"], - "description": "Update the view with the given view Id.", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "delete": { - "summary": "Delete View", - "operationId": "db-view-delete", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "boolean" - }, - "examples": { - "Example 1": { - "value": true - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "description": "Delete the view with the given view Id.", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/views/{viewId}/show-all": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "vw_wtdg2meyig5l4q" - }, - "name": "viewId", - "in": "path", - "required": true, - "description": "Unique View ID" - } - ], - "post": { - "summary": "Show All Columns In View", - "operationId": "db-view-show-all-column", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "boolean" - }, - "examples": { - "Example 1": { - "value": true - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "description": "Show All Columns in a given View", - "parameters": [ - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "ignoreIds" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/views/{viewId}/hide-all": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "vw_wtdg2meyig5l4q" - }, - "name": "viewId", - "in": "path", - "required": true, - "description": "Unique View ID" - } - ], - "post": { - "summary": "Hide All Columns In View", - "operationId": "db-view-hide-all-column", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "boolean" - }, - "examples": { - "Example 1": { - "value": true - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "parameters": [ - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "ignoreIds" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "description": "Hide All Columns in a given View" - } - }, - "/api/v1/db/meta/tables/{tableId}/share": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "md_w9gpnaousnfss1", - "type": "string" - }, - "name": "tableId", - "in": "path", - "required": true, - "description": "Unique Table ID" - } - ], - "get": { - "summary": "List Shared Views", - "operationId": "db-view-share-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SharedViewList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:46:31", - "fk_model_id": "md_mhs9z4r2ak98x0", - "id": "vw_lg052cnc1c26kf", - "is_default": 1, - "lock_type": "collaborative", - "meta": {}, - "order": 1, - "project_id": "p_xm3thidrblw4n7", - "show": 1, - "show_system_fields": null, - "title": "Sheet-1", - "type": 3, - "updated_at": "2023-03-02 17:46:31", - "uuid": null, - "view": { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:46:31", - "fk_view_id": "vw_lg052cnc1c26kf", - "meta": null, - "project_id": "p_xm3thidrblw4n7", - "row_height": null, - "updated_at": "2023-03-02 17:46:31", - "uuid": null - } - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "List all shared views in a given Table", - "tags": ["DB View Share"], - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/views/{viewId}/share": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "vw_wtdg2meyig5l4q" - }, - "name": "viewId", - "in": "path", - "required": true, - "description": "Unique View ID" - } - ], - "post": { - "summary": "Create Shared View", - "operationId": "db-view-share-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SharedViewReq" - }, - "examples": { - "Example 1": { - "value": { - "meta": {}, - "password": "123456789" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View Share"], - "description": "Create a shared view in a given View..", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "patch": { - "summary": "Update Shared View", - "operationId": "db-view-share-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SharedView" - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SharedViewReq" - } - } - }, - "description": "" - }, - "tags": ["DB View Share"], - "description": "Update a shared view in a given View..", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "delete": { - "summary": "Delete Shared View", - "operationId": "db-view-share-delete", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "boolean" - }, - "examples": { - "Example 1": { - "value": true - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Delete a shared view in a given View.", - "tags": ["DB View Share"], - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/views/{viewId}/columns": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "vw_wtdg2meyig5l4q" - }, - "name": "viewId", - "in": "path", - "required": true, - "description": "Unique View ID" - } - ], - "get": { - "summary": "List Columns In View", - "operationId": "db-view-column-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ColumnList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "ai": 0, - "au": 0, - "base_id": "ds_krsappzu9f8vmo", - "cc": "", - "cdf": null, - "clen": "45", - "column_name": "title", - "cop": "2", - "created_at": "2023-03-02 13:14:16", - "csn": "utf8mb4", - "ct": "varchar(45)", - "deleted": null, - "dt": "varchar", - "dtx": "specificType", - "dtxp": "45", - "dtxs": null, - "fk_model_id": "md_yvwvbt2i78rgcm", - "id": "cl_0j9gv0oi8vjy46", - "meta": null, - "np": null, - "ns": null, - "order": 2, - "pk": 0, - "project_id": "p_01clqvzik3izk6", - "pv": 1, - "rqd": 0, - "system": 0, - "title": "Title", - "uidt": "SingleLineText", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 13:14:16", - "validate": null, - "virtual": null - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View Column"], - "description": "List all columns by ViewID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "post": { - "summary": "Create Column in View", - "operationId": "db-view-column-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Column" - }, - "examples": { - "Example 1": { - "value": { - "ai": 0, - "au": 0, - "base_id": "ds_krsappzu9f8vmo", - "cc": "", - "cdf": null, - "clen": "45", - "column_name": "title", - "cop": "2", - "created_at": "2023-03-02 13:14:16", - "csn": "utf8mb4", - "ct": "varchar(45)", - "deleted": null, - "dt": "varchar", - "dtx": "specificType", - "dtxp": "45", - "dtxs": null, - "fk_model_id": "md_yvwvbt2i78rgcm", - "id": "cl_0j9gv0oi8vjy46", - "meta": null, - "np": null, - "ns": null, - "order": 2, - "pk": 0, - "project_id": "p_01clqvzik3izk6", - "pv": 1, - "rqd": 0, - "system": 0, - "title": "Title", - "uidt": "SingleLineText", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 13:14:16", - "validate": null, - "virtual": null - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View Column"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ViewColumnReq" - }, - "examples": { - "Example 1": { - "value": { - "fk_column_id": "cl_m4wkaqgqqjzoeh", - "show": 0, - "order": 1 - } - } - } - } - } - }, - "description": "Create a new column in a given View", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/views/{viewId}/columns/{columnId}": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "vw_wtdg2meyig5l4q" - }, - "name": "viewId", - "in": "path", - "required": true - }, - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "cl_8iw2o4ejzvdyna", - "type": "string" - }, - "name": "columnId", - "in": "path", - "required": true, - "description": "Unique Column ID" - } - ], - "patch": { - "summary": "Update View Column", - "operationId": "db-view-column-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number" - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View Column"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ViewColumnUpdateReq" - }, - "examples": { - "Example 1": { - "value": { - "show": 0, - "order": 1 - } - } - } - } - } - }, - "description": "Update a column in a View", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/views/{viewId}/sorts": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "vw_wtdg2meyig5l4q" - }, - "name": "viewId", - "in": "path", - "required": true, - "description": "Unique View ID" - } - ], - "get": { - "summary": "List View Sorts", - "operationId": "db-table-sort-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SortList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "id": "so_xd4t51uv60ghzl", - "fk_column_id": "cl_l11b769pe2j1ce", - "fk_model_id": "md_ehn5izr99m7d45", - "base_id": "ds_3l9qx8xqksenrl", - "direction": "desc", - "order": 1, - "project_id": "p_9sx43moxhqtjm3" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Sort"], - "description": "List all the sort data in a given View", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "post": { - "summary": "Update View Sort", - "operationId": "db-table-sort-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number" - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Sort"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/SortReq" - }, - { - "type": "object", - "properties": { - "push_to_top": { - "type": "boolean", - "example": true, - "description": "Push the sort to the top of the list" - } - } - } - ] - } - } - } - }, - "description": "Update the sort data in a given View", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/sorts/{sortId}": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "so_xd4t51uv60ghzl" - }, - "name": "sortId", - "in": "path", - "description": "Unique Sort ID", - "required": true - } - ], - "get": { - "summary": "Get Sort", - "operationId": "db-table-sort-get", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Sort" - }, - "examples": { - "Example 1": { - "value": { - "id": "so_xd4t51uv60ghzl", - "fk_column_id": "cl_l11b769pe2j1ce", - "fk_model_id": "md_ehn5izr99m7d45", - "base_id": "ds_3l9qx8xqksenrl", - "direction": "desc", - "order": 1, - "project_id": "p_9sx43moxhqtjm3" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Sort"], - "description": "Get the sort data by Sort ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "patch": { - "summary": "Update Sort", - "operationId": "db-table-sort-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number", - "example": 1 - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Sort"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SortReq" - }, - "examples": { - "Example 1": { - "value": { - "direction": "asc", - "fk_column_id": "cl_l11b769pe2j1ce" - } - } - } - } - } - }, - "description": "Update the sort data by Sort ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "delete": { - "summary": "Delete Sort", - "operationId": "db-table-sort-delete", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "boolean" - }, - "examples": { - "Example 1": { - "value": true - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Sort"], - "description": "Delete the sort data by Sort ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/views/{viewId}/filters": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "vw_wtdg2meyig5l4q" - }, - "name": "viewId", - "in": "path", - "required": true, - "description": "Unique View ID" - } - ], - "get": { - "summary": "Get View Filter", - "operationId": "db-table-filter-read", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FilterList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "comparison_op": "eq", - "comparison_sub_op": null, - "created_at": "2023-03-02 18:18:05", - "fk_column_id": "cl_d7ah9n2qfupgys", - "fk_hook_id": null, - "fk_parent_id": null, - "fk_view_id": "vw_b739e29vqmrxnf", - "id": "fi_xn647tpmdq8fu8", - "is_group": null, - "logical_op": "and", - "order": 1, - "project_id": "p_xm3thidrblw4n7", - "updated_at": "2023-03-02 18:18:05", - "value": "foo" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Filter"], - "description": "Get the filter data in a given View", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "post": { - "summary": "Create View Filter", - "operationId": "db-table-filter-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Filter" - }, - "examples": { - "Example 1": { - "value": { - "base_id": "ds_g4ccx6e77h1dmi", - "comparison_op": "eq", - "comparison_sub_op": null, - "created_at": "2023-03-02 18:18:05", - "fk_column_id": "cl_d7ah9n2qfupgys", - "fk_hook_id": null, - "fk_parent_id": null, - "fk_view_id": "vw_b739e29vqmrxnf", - "id": "fi_xn647tpmdq8fu8", - "is_group": null, - "logical_op": "and", - "order": 1, - "project_id": "p_xm3thidrblw4n7", - "updated_at": "2023-03-02 18:18:05", - "value": "foo" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Filter"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FilterReq" - }, - "examples": { - "Example 1": { - "value": { - "comparison_op": "eq", - "comparison_sub_op": null, - "fk_column_id": "cl_d7ah9n2qfupgys", - "is_group": false, - "logical_op": "and", - "value": "foo" - } - } - } - } - } - }, - "description": "Update the filter data in a given View", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/hooks/{hookId}/filters": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "hk_0063k4o1frnxbr" - }, - "name": "hookId", - "in": "path", - "required": true, - "description": "Unique Hook ID" - } - ], - "get": { - "summary": "Get Hook Filter", - "operationId": "db-table-webhook-filter-read", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FilterList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "comparison_op": "eq", - "comparison_sub_op": null, - "created_at": "2023-03-02 18:18:05", - "fk_column_id": "cl_d7ah9n2qfupgys", - "fk_hook_id": null, - "fk_parent_id": null, - "fk_view_id": "vw_b739e29vqmrxnf", - "id": "fi_xn647tpmdq8fu8", - "is_group": null, - "logical_op": "and", - "order": 1, - "project_id": "p_xm3thidrblw4n7", - "updated_at": "2023-03-02 18:18:05", - "value": "foo" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Webhook Filter"], - "description": "Get the filter data in a given Hook", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "post": { - "summary": "Create Hook Filter", - "operationId": "db-table-webhook-filter-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Filter" - }, - "examples": { - "Example 1": { - "value": { - "base_id": "ds_g4ccx6e77h1dmi", - "comparison_op": "eq", - "comparison_sub_op": null, - "created_at": "2023-03-02 18:18:05", - "fk_column_id": "cl_d7ah9n2qfupgys", - "fk_hook_id": null, - "fk_parent_id": null, - "fk_view_id": "vw_b739e29vqmrxnf", - "id": "fi_xn647tpmdq8fu8", - "is_group": null, - "logical_op": "and", - "order": 1, - "project_id": "p_xm3thidrblw4n7", - "updated_at": "2023-03-02 18:18:05", - "value": "foo" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Webhook Filter"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FilterReq" - }, - "examples": { - "Example 1": { - "value": { - "comparison_op": "eq", - "comparison_sub_op": null, - "fk_column_id": "cl_d7ah9n2qfupgys", - "is_group": false, - "logical_op": "and", - "value": "foo" - } - } - } - } - } - }, - "description": "Create filter(s) in a given Hook", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/hooks/{hookId}/logs": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "hk_0063k4o1frnxbr" - }, - "name": "hookId", - "in": "path", - "required": true, - "description": "Unique Hook ID" - } - ], - "get": { - "summary": "List Hook Logs", - "operationId": "db-table-webhook-logs-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HookLogList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "base_id": "ds_jxuewivwbxeum2", - "event": "after", - "execution_time": "98", - "fk_hook_id": "hk_035ijv5qdi97y5", - "id": "string", - "notifications": "{\"type\":\"URL\",\"payload\":{\"method\":\"POST\",\"body\":\"{{ json data }}\",\"headers\":[{}],\"parameters\":[{}],\"auth\":\"\",\"path\":\"https://webhook.site/6eb45ce5-b611-4be1-8b96-c2965755662b\"}}", - "operation": "insert", - "payload": "{\"method\":\"POST\",\"body\":\"{{ json data }}\",\"headers\":[{}],\"parameters\":[{}],\"auth\":\"\",\"path\":\"https://webhook.site/6eb45ce5-b611-4be1-8b96-c2965755662b\"}", - "project_id": "p_tbhl1hnycvhe5l", - "response": "{\"status\":200,\"statusText\":\"OK\",\"headers\":{\"server\":\"nginx\",\"content-type\":\"text/plain; charset=UTF-8\",\"transfer-encoding\":\"chunked\",\"connection\":\"close\",\"vary\":\"Accept-Encoding\",\"x-request-id\":\"53844a7d-ede8-4798-adf7-8af441908a72\",\"x-token-id\":\"6eb45ce5-b611-4be1-8b96-c2965755662b\",\"cache-control\":\"no-cache, private\",\"date\":\"Fri, 24 Mar 2023 10:50:10 GMT\"},\"config\":{\"url\":\"https://webhook.site/6eb45ce5-b611-4be1-8b96-c2965755662b\",\"method\":\"post\",\"data\":\"{\\\"type\\\":\\\"records.after.insert\\\",\\\"id\\\":\\\"a77d97dc-a3e4-4719-9b46-45f93e0cc99a\\\",\\\"data\\\":{\\\"table_id\\\":\\\"md_d8v403o74mf5lf\\\",\\\"table_name\\\":\\\"Sheet-2\\\"}}\",\"headers\":{\"Accept\":\"application/json, text/plain, */*\",\"Content-Type\":\"application/x-www-form-urlencoded\",\"User-Agent\":\"axios/0.21.4\",\"Content-Length\":138},\"params\":{}}}", - "test_call": 0, - "triggered_by": "w@nocodb.com", - "type": "URL" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Webhook Logs"], - "description": "List the log data in a given Hook", - "parameters": [ - { - "schema": { - "type": "integer", - "minimum": 1 - }, - "in": "query", - "name": "limit" - }, - { - "schema": { - "type": "integer", - "minimum": 0 - }, - "in": "query", - "name": "offset" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/filters/{filterId}": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "pattern": "fi_pgfuo11uhn2xeo" - }, - "name": "filterId", - "in": "path", - "required": true, - "description": "Unique Filter ID" - } - ], - "get": { - "summary": "Get Filter", - "operationId": "db-table-filter-get", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Filter" - }, - "examples": { - "Example 1": { - "value": { - "base_id": "ds_g4ccx6e77h1dmi", - "comparison_op": "eq", - "comparison_sub_op": null, - "created_at": "2023-03-02 18:18:05", - "fk_column_id": "cl_d7ah9n2qfupgys", - "fk_hook_id": null, - "fk_parent_id": null, - "fk_view_id": "vw_b739e29vqmrxnf", - "id": "fi_xn647tpmdq8fu8", - "is_group": null, - "logical_op": "and", - "order": 1, - "project_id": "p_xm3thidrblw4n7", - "updated_at": "2023-03-02 18:18:05", - "value": "foo" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Filter"], - "description": "Get the filter data with a given Filter ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "patch": { - "summary": "Update Filter", - "operationId": "db-table-filter-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number" - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Filter"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FilterReq" - }, - "examples": { - "Example 1": { - "value": { - "comparison_op": "eq", - "comparison_sub_op": null, - "fk_column_id": "cl_d7ah9n2qfupgys", - "is_group": false, - "logical_op": "and", - "value": "foo" - } - } - } - } - } - }, - "description": "Update the filter data with a given Filter ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "delete": { - "summary": "Delete Filter", - "operationId": "db-table-filter-delete", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "boolean" - }, - "examples": { - "Example 1": { - "value": true - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Filter"], - "description": "Delete the filter data with a given Filter ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/filters/{filterGroupId}/children": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "fi_pgfuo11uhn2xeo", - "description": "Filter Group ID" - }, - "name": "filterGroupId", - "in": "path", - "required": true - } - ], - "get": { - "summary": "Get Filter Group Children", - "operationId": "db-table-filter-children-read", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FilterList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "comparison_op": "eq", - "comparison_sub_op": null, - "created_at": "2023-03-02 18:18:05", - "fk_column_id": "cl_d7ah9n2qfupgys", - "fk_hook_id": null, - "fk_parent_id": null, - "fk_view_id": "vw_b739e29vqmrxnf", - "id": "fi_xn647tpmdq8fu8", - "is_group": null, - "logical_op": "and", - "order": 1, - "project_id": "p_xm3thidrblw4n7", - "updated_at": "2023-03-02 18:18:05", - "value": "foo" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Filter"], - "description": "Get Filter Group Children of a given group ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/tables/{tableId}/grids": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "md_w9gpnaousnfss1", - "type": "string" - }, - "name": "tableId", - "in": "path", - "required": true, - "description": "Unique Table ID" - } - ], - "post": { - "summary": "Create Grid View", - "operationId": "db-view-grid-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/View" - }, - "examples": { - "Example 1": { - "value": { - "id": "vw_o50jiw9v2txktv", - "base_id": "ds_a95vextjl510z7", - "project_id": "p_slkm6i3v31q4bc", - "fk_model_id": "md_8hr3xndx8umuce", - "title": "Grid-1", - "type": 3, - "is_default": null, - "show_system_fields": null, - "lock_type": "collaborative", - "uuid": null, - "password": null, - "show": true, - "order": 2, - "created_at": "2023-03-13T07:29:16.610Z", - "updated_at": "2023-03-13T07:29:16.610Z", - "meta": {} - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ViewCreateReq" - }, - "examples": { - "Example 1": { - "value": { - "title": "My Grid View", - "type": 3, - "copy_from_id": null, - "fk_grp_col_id": null, - "fk_geo_data_col_id": null - } - } - } - } - } - }, - "description": "Create a new grid view in a given Table", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/tables/{tableId}/forms": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "md_w9gpnaousnfss1", - "type": "string" - }, - "name": "tableId", - "in": "path", - "required": true, - "description": "Unique Table ID" - } - ], - "post": { - "summary": "Create Form View", - "operationId": "db-view-form-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/View" - }, - "examples": { - "Example 1": { - "value": { - "id": "vw_a830n4bmwk8wlp", - "base_id": "ds_a95vextjl510z7", - "project_id": "p_slkm6i3v31q4bc", - "fk_model_id": "md_8hr3xndx8umuce", - "title": "Form-1", - "type": 1, - "is_default": null, - "show_system_fields": null, - "lock_type": "collaborative", - "uuid": null, - "password": null, - "show": true, - "order": 4, - "created_at": "2023-03-13T07:29:19.957Z", - "updated_at": "2023-03-13T07:29:19.957Z", - "meta": {} - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Create a new form view in a given Table", - "tags": ["DB View"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ViewCreateReq" - }, - "examples": { - "Example 1": { - "value": { - "title": "My Form View", - "type": 1, - "copy_from_id": null, - "fk_grp_col_id": null, - "fk_geo_data_col_id": null - } - } - } - } - } - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/forms/{formViewId}": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "vw_6fqln9vdytdv8q" - }, - "name": "formViewId", - "in": "path", - "required": true, - "description": "Unique Form View ID" - } - ], - "patch": { - "summary": "Update Form View", - "operationId": "db-view-form-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number" - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FormUpdateReq" - }, - "examples": { - "Example 1": { - "value": { - "banner_image_url": null, - "email": "user@example.com", - "heading": "My Form", - "lock_type": "collaborative", - "logo_url": null, - "meta": null, - "redirect_after_secs": null, - "redirect_url": null, - "show_blank_form": 0, - "subheading": "My Form Subheading", - "submit_another_form": 0, - "success_msg": "Thank you for the submission.", - "title": "Form View 1" - } - } - } - } - } - }, - "description": "Update the form data by Form ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "get": { - "summary": "Get Form", - "operationId": "db-view-form-read", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Form" - }, - "examples": { - "Example 1": { - "value": { - "base_id": "ds_g4ccx6e77h1dmi", - "banner_image_url": null, - "columns": [ - { - "id": "fvc_ugj9zo5bzocxtl", - "base_id": "ds_g4ccx6e77h1dmi", - "project_id": "p_xm3thidrblw4n7", - "fk_view_id": "vw_kdf5cr7qmhksek", - "fk_column_id": "cl_phvuuwjrzcdo0g", - "uuid": null, - "label": null, - "help": null, - "description": null, - "required": null, - "show": 0, - "order": 1, - "created_at": "2023-03-04 16:40:47", - "updated_at": "2023-03-04 16:40:47", - "meta": {} - } - ], - "email": "user@example.com", - "fk_model_id": "md_rsu68aqjsbyqtl", - "heading": "My Form", - "lock_type": "collaborative", - "logo_url": null, - "meta": null, - "redirect_after_secs": null, - "redirect_url": null, - "show_blank_form": 0, - "subheading": "My Form Subheading", - "submit_another_form": 0, - "success_msg": "Thank you for the submission.", - "title": "Form View 1" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "description": "Get the form data by Form ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/form-columns/{formViewColumnId}": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "fvc_1m9b0aub791d4m", - "type": "string" - }, - "name": "formViewColumnId", - "in": "path", - "required": true, - "description": "Unique Form View Column ID" - } - ], - "patch": { - "summary": "Update Form Column", - "operationId": "db-view-form-column-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FormColumnReq" - }, - "examples": { - "Example 1": { - "value": { - "description": null, - "help": "This is a help text", - "label": "Form Label", - "meta": null, - "order": 1, - "required": 0, - "show": 0 - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FormColumnReq" - } - } - } - }, - "description": "Update the form column(s) by Form View Column ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/grids/{viewId}": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "vw_wtdg2meyig5l4q" - }, - "name": "viewId", - "in": "path", - "required": true, - "description": "Unique View ID" - } - ], - "patch": { - "summary": "Update Grid View", - "operationId": "db-view-grid-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number" - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GridUpdateReq" - }, - "examples": { - "Example 1": { - "value": { - "row_height": 1, - "meta": null - } - } - } - } - } - }, - "description": "Update Grid View", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/grids/{gridId}/grid-columns": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "vw_q6k13mmygdi3yz" - }, - "name": "gridId", - "in": "path", - "required": true, - "description": "Grid View ID" - } - ], - "get": { - "summary": "List Grid Columns", - "operationId": "db-view-grid-columns-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GridColumn" - } - }, - "examples": { - "Example 1": { - "value": [ - { - "id": "nc_c8jz4kxe6xvh11", - "fk_view_id": "vw_p2jcatxz4mvcfw", - "fk_column_id": "cl_c5knoi4xs4sfpt", - "project_id": "p_xm3thidrblw4n7", - "base_id": "ds_g4ccx6e77h1dmi", - "show": 0, - "order": 1, - "width": "200px", - "help": null - } - ] - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "description": "List all columns in the given Grid", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/grid-columns/{columnId}": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "cl_8iw2o4ejzvdyna", - "type": "string" - }, - "name": "columnId", - "in": "path", - "required": true, - "description": "Unique Column ID" - } - ], - "patch": { - "summary": "Update Grid Column", - "operationId": "db-view-grid-column-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number" - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GridColumnReq" - }, - "examples": { - "Example 1": { - "value": { - "fk_column_id": "cl_c5knoi4xs4sfpt", - "label": "My Column", - "width": "200px" - } - } - } - } - } - }, - "description": "Update grid column(s) in the given Grid", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/tables/{tableId}/galleries": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "md_w9gpnaousnfss1" - }, - "name": "tableId", - "in": "path", - "required": true, - "description": "Unique Table ID" - } - ], - "post": { - "summary": "Create Gallery View", - "operationId": "db-view-gallery-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/View" - }, - "examples": { - "Example 1": { - "value": { - "id": "vw_qp94qfnvffgk5f", - "base_id": "ds_a95vextjl510z7", - "project_id": "p_slkm6i3v31q4bc", - "fk_model_id": "md_8hr3xndx8umuce", - "title": "Gallery-1", - "type": 2, - "is_default": null, - "show_system_fields": null, - "lock_type": "collaborative", - "uuid": null, - "password": null, - "show": true, - "order": 3, - "created_at": "2023-03-13T07:29:18.707Z", - "updated_at": "2023-03-13T07:29:18.707Z", - "meta": {} - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ViewCreateReq" - }, - "examples": { - "Example 1": { - "value": { - "title": "My Gallery View", - "type": 2, - "copy_from_id": null, - "fk_grp_col_id": null, - "fk_geo_data_col_id": null - } - } - } - } - } - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/galleries/{galleryViewId}": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "vw_1eq2wk2xe3a9j5" - }, - "name": "galleryViewId", - "in": "path", - "required": true, - "description": "Unique Gallery View ID" - } - ], - "patch": { - "summary": "Update Gallery View", - "operationId": "db-view-gallery-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number" - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GalleryUpdateReq" - }, - "examples": { - "Example 1": { - "value": { - "fk_cover_image_col_id": "cl_ib8l4j1kiu1efx", - "meta": null - } - } - } - } - } - }, - "description": "Update the Gallery View data with Gallery ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "get": { - "summary": "Get Gallery View", - "operationId": "db-view-gallery-read", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Gallery" - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "description": "Get the Gallery View data with Gallery ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/tables/{tableId}/kanbans": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "md_w9gpnaousnfss1", - "type": "string" - }, - "name": "tableId", - "in": "path", - "required": true, - "description": "Unique Table ID" - } - ], - "post": { - "summary": "Create Kanban View", - "operationId": "db-view-kanban-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/View" - }, - "examples": { - "Example 1": { - "value": { - "id": "vw_569sqsrp2vuff4", - "base_id": "ds_a95vextjl510z7", - "project_id": "p_slkm6i3v31q4bc", - "fk_model_id": "md_8hr3xndx8umuce", - "title": "Kanban-1", - "type": 4, - "is_default": null, - "show_system_fields": null, - "lock_type": "collaborative", - "uuid": null, - "password": null, - "show": true, - "order": 5, - "created_at": "2023-03-13T07:29:21.387Z", - "updated_at": "2023-03-13T07:29:21.387Z", - "meta": {} - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ViewCreateReq" - }, - "examples": { - "Example 1": { - "value": { - "title": "My Kanban View", - "type": 4, - "copy_from_id": null, - "fk_grp_col_id": "cl_g0a89q9xdry3lu", - "fk_geo_data_col_id": null - } - } - } - } - } - }, - "description": "Create a new Kanban View", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/kanbans/{kanbanViewId}": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "vw_1eq2wk2xe3a9j5" - }, - "name": "kanbanViewId", - "in": "path", - "required": true, - "description": "Unique Kanban View ID" - } - ], - "patch": { - "summary": "Update Kanban View", - "operationId": "db-view-kanban-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number" - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/KanbanUpdateReq" - }, - "examples": { - "Example 1": { - "value": { - "fk_grp_col_id": "cl_g0a89q9xdry3lu", - "fk_cover_image_col_id": "cl_ib8l4j1kiu1efx", - "meta": { - "cl_g0a89q9xdry3lu": [ - { - "id": "uncategorized", - "title": null, - "order": 0, - "color": "#c2f5e8", - "collapsed": false - }, - { - "id": "sl_ihyva6jx6dg0fc", - "fk_column_id": "cl_g0a89q9xdry3lu", - "title": "a", - "color": "#cfdffe", - "order": 1, - "collapsed": false - }, - { - "id": "sl_gqdm5v6t8aetoa", - "fk_column_id": "cl_g0a89q9xdry3lu", - "title": "b", - "color": "#d0f1fd", - "order": 2, - "collapsed": false - }, - { - "id": "sl_eipnl0kn7a9d3c", - "fk_column_id": "cl_g0a89q9xdry3lu", - "title": "cc", - "color": "#c2f5e8", - "order": 3, - "collapsed": false - }, - { - "id": "sl_dei8p2jq0cnlv0", - "fk_column_id": "cl_g0a89q9xdry3lu", - "title": "d", - "color": "#ffdaf6", - "order": 4, - "collapsed": false - } - ] - } - } - } - } - } - } - }, - "description": "Update the Kanban View data with Kanban ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "get": { - "summary": "Get Kanban View", - "operationId": "db-view-kanban-read", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Kanban" - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "description": "Get the Kanban View data by Kanban ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/tables/{tableId}/maps": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "md_w9gpnaousnfss1", - "type": "string" - }, - "name": "tableId", - "in": "path", - "required": true, - "description": "Unique Table ID" - } - ], - "post": { - "summary": "Create Map View", - "operationId": "db-view-map-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/View" - }, - "examples": { - "Example 1": { - "value": { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:46:31", - "fk_model_id": "md_mhs9z4r2ak98x0", - "id": "vw_lg052cnc1c26kf", - "is_default": 1, - "lock_type": "collaborative", - "meta": {}, - "order": 1, - "password": null, - "project_id": "p_xm3thidrblw4n7", - "show": 1, - "show_system_fields": null, - "title": "Sheet-1", - "type": 3, - "updated_at": "2023-03-02 17:46:31", - "uuid": null - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ViewCreateReq" - }, - "examples": { - "Example 1": { - "value": { - "title": "My Map View", - "type": 5, - "copy_from_id": null, - "fk_grp_col_id": null, - "fk_geo_data_col_id": "cl_uu1meolj00tlrq" - } - } - } - } - }, - "description": "" - }, - "description": "Create a new Map View", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/maps/{mapViewId}": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "vw_1eq2wk2xe3a9j5" - }, - "name": "mapViewId", - "in": "path", - "required": true, - "description": "Unique Map View ID" - } - ], - "patch": { - "summary": "Update Map View", - "operationId": "db-view-map-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number" - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/MapUpdateReq" - }, - "examples": { - "Example 1": { - "value": { - "fk_geo_data_col_id": "cl_8iw2o4ejzvdyna", - "meta": null - } - } - } - } - } - }, - "description": "Update the Map View data by Map ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "get": { - "summary": "Get Map View", - "operationId": "db-view-map-read", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Map" - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "description": "Get the Map View data by Map ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/projects/{projectId}/meta-diff": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - } - ], - "post": { - "summary": "Sync Meta", - "operationId": "project-meta-diff-sync", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "la6fd99uw6eao" - }, - "example": "The meta has been synchronized successfully" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "The meta has been synchronized successfully" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Project"], - "description": "Synchronise the meta data difference between NC_DB and external data sources ", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "get": { - "summary": "Meta Diff", - "operationId": "project-meta-diff-get", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["Project"], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "x-stoplight": { - "id": "awdkjwr7uultr" - }, - "type": "object", - "properties": { - "table_name": { - "type": "string", - "x-stoplight": { - "id": "jjj8ufafq1sd2" - }, - "description": "Table Name", - "example": "Table 1" - }, - "base_id": { - "type": "string", - "x-stoplight": { - "id": "smx2or6bv1xym" - }, - "description": "Base ID", - "example": "ds_rrplkgy0pq1f3c" - }, - "type": { - "type": "string", - "x-stoplight": { - "id": "zr19ahh1s6d13" - }, - "description": "Change Type", - "example": "table" - }, - "detectedChanges": { - "type": "array", - "x-stoplight": { - "id": "bptxla2y27aq6" - }, - "description": "Detected Changes", - "items": { - "x-stoplight": { - "id": "ob16o1ln7xy8o" - }, - "type": "object" - } - } - } - } - }, - "examples": { - "Example 1": { - "value": [ - { - "table_name": "_nc_m2m_uuv_xzru3m", - "base_id": "ds_rrplkgy0pq1f3c", - "type": "table", - "detectedChanges": [ - { - "type": "TABLE_NEW", - "msg": "New table" - }, - { - "type": "TABLE_RELATION_ADD", - "tn": "_nc_m2m_uuv_xzru3m", - "rtn": "Sheet-1", - "cn": "table1_id", - "rcn": "id", - "msg": "New relation added", - "relationType": "bt", - "cstn": "_nc_m2m_uuv_xzru3m_table1_id_foreign" - }, - { - "type": "TABLE_RELATION_ADD", - "tn": "_nc_m2m_uuv_xzru3m", - "rtn": "address", - "cn": "table2_id", - "rcn": "address_id", - "msg": "New relation added", - "relationType": "bt", - "cstn": "_nc_m2m_uuv_xzru3m_table2_id_foreign" - } - ] - } - ] - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Get the meta data difference between NC_DB and external data sources " - } - }, - "/api/v1/db/meta/projects/{projectId}/meta-diff/{baseId}": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - }, - { - "schema": { - "type": "string", - "pattern": "ds_j04jmxh5xg10lu" - }, - "name": "baseId", - "in": "path", - "required": true, - "description": "Unique Base ID" - } - ], - "post": { - "summary": "Synchronise Base Meta", - "operationId": "base-meta-diff-sync", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "acy7tx4rounqw" - }, - "example": "The base meta has been synchronized successfully" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "The base meta has been synchronized successfully" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Base"], - "description": "Synchronise the meta data difference between NC_DB and external data sources in a given Base", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "get": { - "summary": "Base Meta Diff", - "operationId": "base-meta-diff-get", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["Base"], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "x-stoplight": { - "id": "pav4jmel1ebeu" - }, - "type": "object", - "properties": { - "table_name": { - "type": "string", - "x-stoplight": { - "id": "xjw4k4httzmaf" - }, - "description": "Table Name", - "example": "Table 1" - }, - "base_id": { - "type": "string", - "x-stoplight": { - "id": "l1o3qhkgagsdl" - }, - "example": "ds_rrplkgy0pq1f3c", - "description": "Base ID" - }, - "type": { - "type": "string", - "x-stoplight": { - "id": "v5ciaygrj64uh" - }, - "description": "Change Type", - "example": "table" - }, - "detectedChanges": { - "type": "array", - "x-stoplight": { - "id": "wqn5noi0e46q8" - }, - "description": "Detected Changes", - "items": { - "x-stoplight": { - "id": "r2roo274wquvf" - }, - "type": "object" - } - } - } - } - }, - "examples": { - "Example 1": { - "value": [ - { - "table_name": "_nc_m2m_uuv_xzru3m", - "base_id": "ds_rrplkgy0pq1f3c", - "type": "table", - "detectedChanges": [ - { - "type": "TABLE_NEW", - "msg": "New table" - }, - { - "type": "TABLE_RELATION_ADD", - "tn": "_nc_m2m_uuv_xzru3m", - "rtn": "Sheet-1", - "cn": "table1_id", - "rcn": "id", - "msg": "New relation added", - "relationType": "bt", - "cstn": "_nc_m2m_uuv_xzru3m_table1_id_foreign" - }, - { - "type": "TABLE_RELATION_ADD", - "tn": "_nc_m2m_uuv_xzru3m", - "rtn": "address", - "cn": "table2_id", - "rcn": "address_id", - "msg": "New relation added", - "relationType": "bt", - "cstn": "_nc_m2m_uuv_xzru3m_table2_id_foreign" - } - ] - } - ] - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Get the meta data difference between NC_DB and external data sources in a given Base" - } - }, - "/api/v1/db/meta/projects/{projectId}/has-empty-or-null-filters": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - } - ], - "get": { - "summary": "List Empty & Null Filter", - "operationId": "project-has-empty-or-null-filters", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["Project"], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": {} - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Check if a project contains empty and null filters. Used in `Show NULL and EMPTY in Filter` in Project Setting.", - "x-internal": true - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - } - ], - "get": { - "summary": "List Table Rows", - "operationId": "db-table-row-list", - "description": "List all table rows in a given table and project", - "tags": ["DB Table Row"], - "parameters": [ - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "fields", - "description": "Which fields to be shown" - }, - { - "schema": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "type": "string" - } - ] - }, - "in": "query", - "name": "sort", - "description": "The result will be sorted based on `sort` query" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where", - "description": "Extra filtering" - }, - { - "schema": { - "type": "integer", - "minimum": 0 - }, - "in": "query", - "name": "offset", - "description": "Offset in rows" - }, - { - "schema": { - "type": "integer", - "minimum": 1 - }, - "in": "query", - "name": "limit", - "description": "Limit in rows" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "sortArrJson", - "description": "Used for multiple sort queries" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "filterArrJson", - "description": "Used for multiple filter queries" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "list": { - "type": "array", - "x-stoplight": { - "id": "g92aqxk869a7o" - }, - "description": "List of data objects", - "items": { - "x-stoplight": { - "id": "rnbt8ubciknfd" - }, - "type": "object" - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated", - "x-stoplight": { - "id": "7f38yyzdg03x5" - }, - "description": "Paginated Info" - } - }, - "required": ["list", "pageInfo"] - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "Id": 1, - "Title": "baz", - "SingleSelect": null, - "Sheet-1 List": [ - { - "Id": 1, - "Title": "baz" - } - ], - "LTAR": [ - { - "Id": 1, - "Title": "baz" - } - ] - }, - { - "Id": 2, - "Title": "foo", - "SingleSelect": "a", - "Sheet-1 List": [ - { - "Id": 2, - "Title": "foo" - } - ], - "LTAR": [ - { - "Id": 2, - "Title": "foo" - } - ] - }, - { - "Id": 3, - "Title": "bar", - "SingleSelect": "b", - "Sheet-1 List": [], - "LTAR": [] - } - ], - "pageInfo": { - "totalRows": 3, - "page": 1, - "pageSize": 25, - "isFirstPage": true, - "isLastPage": true - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - } - }, - "post": { - "summary": "Create Table Row", - "operationId": "db-table-row-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": {} - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Row"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "examples": { - "Example 1": { - "value": { - "Id": 1, - "Title": "foo", - "CreatedAt": "2023-03-11T09:10:53.567Z", - "UpdatedAt": "2023-03-11T09:10:53.567Z" - } - } - } - } - } - }, - "description": "Create a new row in a given table and project.", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/find-one": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - } - ], - "get": { - "summary": "Find One Table Row", - "operationId": "db-table-row-find-one", - "description": "Return the first result of the target Table Row", - "tags": ["DB Table Row"], - "parameters": [ - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "fields" - }, - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "sort" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "examples": { - "Example 1": { - "value": { - "Id": 1, - "Title": "foo", - "CreatedAt": "2023-03-11T09:10:53.567Z", - "UpdatedAt": "2023-03-11T09:10:53.567Z" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - } - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/groupby": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "column_name", - "description": "Column name of the column you want to group by, eg. `column_name=column1`" - } - ], - "get": { - "summary": "Group By Table Row", - "operationId": "db-table-row-group-by", - "description": "Get the result grouped by the given query", - "tags": ["DB Table Row"], - "parameters": [ - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "sort" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where" - }, - { - "schema": { - "type": "integer", - "minimum": 1 - }, - "in": "query", - "name": "limit" - }, - { - "schema": { - "type": "integer", - "minimum": 0 - }, - "in": "query", - "name": "offset" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": {} - } - } - } - } - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/views/{viewName}/group/{columnId}": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string", - "example": "p_tbhl1hnycvhe5l" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string", - "example": "md_5hua2iqloqirhd" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "type": "string", - "example": "vw_mldv0a5mtwh1la" - }, - "name": "viewName", - "in": "path", - "required": true, - "description": "View Name" - }, - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "cl_8iw2o4ejzvdyna", - "type": "string" - }, - "name": "columnId", - "in": "path", - "required": true, - "description": "Unique Column ID" - } - ], - "get": { - "summary": "Table Group by Column", - "operationId": "db-view-row-grouped-data-list", - "description": "Get the grouped data By Column ID. Used in Kanban View.", - "tags": ["DB View Row"], - "parameters": [ - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "fields" - }, - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "sort" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where" - }, - { - "schema": {}, - "in": "query", - "name": "nested", - "description": "Query params for nested data" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": {} - }, - "examples": { - "Example 1": { - "value": [ - { - "key": "a", - "value": { - "list": [ - { - "Id": 2, - "Title": "foo", - "SingleSelect": "a" - } - ], - "pageInfo": { - "totalRows": 1, - "page": 1, - "pageSize": 25, - "isFirstPage": true, - "isLastPage": true - } - } - }, - { - "key": "b", - "value": { - "list": [ - { - "Id": 3, - "Title": "bar", - "SingleSelect": "b" - } - ], - "pageInfo": { - "totalRows": 1, - "page": 1, - "pageSize": 25, - "isFirstPage": true, - "isLastPage": true - } - } - }, - { - "key": null, - "value": { - "list": [ - { - "Id": 1, - "Title": "baz", - "SingleSelect": null - }, - { - "Id": 5, - "Title": "xyz", - "SingleSelect": null - } - ], - "pageInfo": { - "totalRows": 2, - "page": 1, - "pageSize": 25, - "isFirstPage": true, - "isLastPage": true - } - } - } - ] - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - } - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/group/{columnId}": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string", - "example": "p_tbhl1hnycvhe5l" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string", - "example": "md_5hua2iqloqirhd" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "cl_8iw2o4ejzvdyna", - "type": "string" - }, - "name": "columnId", - "in": "path", - "required": true, - "description": "Unique Column ID" - } - ], - "get": { - "summary": "Table Group by Column", - "operationId": "db-table-row-grouped-data-list", - "description": "Get the grouped data By Column ID. Used in Kanban View.", - "tags": ["DB Table Row"], - "parameters": [ - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "fields" - }, - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "sort" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where" - }, - { - "schema": {}, - "in": "query", - "name": "nested", - "description": "Query params for nested data" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": {} - }, - "examples": { - "Example 1": { - "value": [ - { - "key": "a", - "value": { - "list": [ - { - "Id": 2, - "Title": "foo", - "SingleSelect": "a" - } - ], - "pageInfo": { - "totalRows": 1, - "page": 1, - "pageSize": 25, - "isFirstPage": true, - "isLastPage": true - } - } - }, - { - "key": "b", - "value": { - "list": [ - { - "Id": 3, - "Title": "bar", - "SingleSelect": "b" - } - ], - "pageInfo": { - "totalRows": 1, - "page": 1, - "pageSize": 25, - "isFirstPage": true, - "isLastPage": true - } - } - }, - { - "key": null, - "value": { - "list": [ - { - "Id": 1, - "Title": "baz", - "SingleSelect": null - }, - { - "Id": 5, - "Title": "xyz", - "SingleSelect": null - } - ], - "pageInfo": { - "totalRows": 2, - "page": 1, - "pageSize": 25, - "isFirstPage": true, - "isLastPage": true - } - } - } - ] - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - } - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/views/{viewName}": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "type": "string" - }, - "name": "viewName", - "in": "path", - "required": true - } - ], - "get": { - "summary": "List Table View Rows", - "operationId": "db-view-row-list", - "description": "List all table view rows", - "tags": ["DB View Row"], - "parameters": [ - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "fields" - }, - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "sort" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where" - }, - { - "schema": {}, - "in": "query", - "name": "nested", - "description": "Query params for nested data" - }, - { - "schema": { - "type": "number" - }, - "in": "query", - "name": "offset" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "list": { - "type": "array", - "x-stoplight": { - "id": "okd8utzm9xqet" - }, - "description": "List of table view rows", - "items": { - "x-stoplight": { - "id": "j758lsjv53o4q" - }, - "type": "object" - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated", - "x-stoplight": { - "id": "hylgqzgm8yhye" - }, - "description": "Paginated Info" - } - }, - "required": ["list", "pageInfo"] - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "Id": 1, - "Title": "baz", - "SingleSelect": null, - "Sheet-1 List": [ - { - "Id": 1, - "Title": "baz" - } - ], - "LTAR": [ - { - "Id": 1, - "Title": "baz" - } - ] - }, - { - "Id": 2, - "Title": "foo", - "SingleSelect": "a", - "Sheet-1 List": [ - { - "Id": 2, - "Title": "foo" - } - ], - "LTAR": [ - { - "Id": 2, - "Title": "foo" - } - ] - }, - { - "Id": 3, - "Title": "bar", - "SingleSelect": "b", - "Sheet-1 List": [], - "LTAR": [] - } - ], - "pageInfo": { - "totalRows": 3, - "page": 1, - "pageSize": 25, - "isFirstPage": true, - "isLastPage": true - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - } - }, - "post": { - "summary": "Create Table View Row", - "operationId": "db-view-row-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "examples": { - "Example 1": { - "value": { - "Id": 1, - "col1": "foo", - "col2": "bar", - "CreatedAt": "2023-03-11T08:48:25.598Z", - "UpdatedAt": "2023-03-11T08:48:25.598Z" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View Row"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "examples": { - "Example 1": { - "value": { - "col1": "foo", - "col2": "bar" - } - } - } - } - } - }, - "description": "Create a new row in the given Table View" - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/views/{viewName}/find-one": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "type": "string" - }, - "name": "viewName", - "in": "path", - "required": true - } - ], - "get": { - "summary": "Find One Table View Row", - "operationId": "db-view-row-find-one", - "description": "Return the first result of table view rows with the given query", - "tags": ["DB View Row"], - "parameters": [ - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "fields" - }, - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "sort" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where" - }, - { - "schema": {}, - "in": "query", - "name": "nested", - "description": "Query params for nested data" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "examples": { - "Example 1": { - "value": { - "Id": 1, - "Title": "foo", - "CreatedAt": "2023-03-11T09:10:53.567Z", - "UpdatedAt": "2023-03-11T09:10:53.567Z" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - } - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/views/{viewName}/groupby": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "type": "string" - }, - "name": "viewName", - "in": "path", - "required": true - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "column_name", - "description": "Column name of the column you want to group by, eg. `column_name=column1`" - } - ], - "get": { - "summary": "Group By Table View Row", - "operationId": "db-view-row-group-by", - "description": "Get the table view rows groupe by the given query", - "tags": ["DB View Row"], - "parameters": [ - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "sort" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where" - }, - { - "schema": { - "type": "integer", - "minimum": 1 - }, - "in": "query", - "name": "limit" - }, - { - "schema": { - "type": "integer", - "minimum": 0 - }, - "in": "query", - "name": "offset" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": {} - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - } - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/views/{viewName}/count": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "type": "string", - "example": "vw_75neroyqdye94k" - }, - "name": "viewName", - "in": "path", - "required": true, - "description": "View Name" - } - ], - "get": { - "summary": "Count Table View Rows", - "operationId": "db-view-row-count", - "description": "Count how many rows in the given Table View", - "tags": ["DB View Row"], - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where" - }, - { - "schema": {}, - "in": "query", - "name": "nested", - "description": "Query params for nested data" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "count": { - "type": "number", - "x-stoplight": { - "id": "hwq29x70rcipi" - } - } - } - }, - "examples": { - "Example 1": { - "value": { - "count": 25 - } - } - } - } - } - } - } - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/views/{viewName}/{rowId}": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "type": "string", - "example": "vw_75neroyqdye94k" - }, - "name": "viewName", - "in": "path", - "required": true, - "description": "View Name" - }, - { - "schema": { - "example": "1" - }, - "name": "rowId", - "in": "path", - "required": true, - "description": "Unique Row ID" - } - ], - "get": { - "summary": "Get Table View Row", - "operationId": "db-view-row-read", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {} - }, - "examples": { - "Example 1": { - "value": { - "Id": 1, - "Title": "foo", - "CreatedAt": "2023-03-11T09:11:47.437Z", - "UpdatedAt": "2023-03-11T09:11:47.784Z" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Get the target Table View Row", - "tags": ["DB View Row"], - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "patch": { - "summary": "Update Table View Row", - "operationId": "db-view-row-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "examples": { - "Example 1": { - "value": { - "Id": 1, - "Title": "bar", - "CreatedAt": "2023-03-11T09:11:47.437Z", - "UpdatedAt": "2023-03-11T09:20:21.133Z" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View Row"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "examples": { - "Example 1": { - "value": { - "Title": "bar" - } - } - } - } - } - }, - "description": "Update the target Table View Row", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "delete": { - "summary": "Delete Table View Row", - "operationId": "db-view-row-delete", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number" - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View Row"], - "description": "Delete the target Table View Row", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/views/{viewName}/{rowId}/exist": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "type": "string" - }, - "name": "viewName", - "in": "path", - "required": true - }, - { - "schema": { - "example": "1" - }, - "name": "rowId", - "in": "path", - "required": true, - "description": "Unique Row ID" - } - ], - "get": { - "summary": "Does Table View Row Exist", - "operationId": "db-view-row-exist", - "responses": { - "201": { - "description": "Created", - "content": { - "application/json": { - "schema": { - "type": "number" - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Check row with provided primary key exists or not", - "tags": ["DB View Row"], - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/{rowId}": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "example": "1" - }, - "name": "rowId", - "in": "path", - "required": true, - "description": "Unique Row ID" - } - ], - "get": { - "summary": "Get Table Row", - "operationId": "db-table-row-read", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {} - }, - "examples": { - "Example 1": { - "value": { - "Id": 1, - "Title": "foo", - "CreatedAt": "2023-03-11T09:11:47.437Z", - "UpdatedAt": "2023-03-11T09:11:47.784Z" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Get the Table Row by Row ID", - "tags": ["DB Table Row"], - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "patch": { - "summary": "Update Table Row", - "operationId": "db-table-row-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "examples": { - "Example 1": { - "value": { - "Id": 1, - "Title": "bar", - "CreatedAt": "2023-03-11T09:11:47.437Z", - "UpdatedAt": "2023-03-11T09:20:21.133Z" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Row"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "examples": { - "Example 1": { - "value": { - "Title": "bar" - } - } - } - } - } - }, - "description": "Update the Table Row", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "delete": { - "summary": "Delete Table Row", - "operationId": "db-table-row-delete", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number" - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Row"], - "description": "Delete the Table Row", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/{rowId}/exist": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "example": "1" - }, - "name": "rowId", - "in": "path", - "required": true, - "description": "Unique Row ID" - } - ], - "get": { - "summary": "Does Table Row Exist", - "operationId": "db-table-row-exist", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number" - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "check row with provided primary key exists or not", - "tags": ["DB Table Row"], - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/data/bulk/{orgs}/{projectName}/{tableName}": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - } - ], - "post": { - "summary": "Bulk Insert Table Rows", - "operationId": "db-table-row-bulk-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "description": "List of returned IDs", - "items": { - "x-stoplight": { - "id": "dbkhyd3mnajax" - }, - "type": "object", - "properties": { - "id": { - "type": "string", - "x-stoplight": { - "id": "lnwqjl14f287f" - } - } - } - } - }, - "examples": { - "Example 1": { - "value": [ - { - "id": 1 - }, - { - "id": 2 - } - ] - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Row"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "array", - "description": "List of data objects", - "items": { - "x-stoplight": { - "id": "7u0mp8nzlvysz" - }, - "type": "object" - } - }, - "examples": { - "Example 1": { - "value": [ - { - "Title": "abc" - }, - { - "Title": "def" - } - ] - } - } - } - }, - "description": "" - }, - "description": "Bulk insert table rows in one go.", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "patch": { - "summary": "Bulk Update Table Rows by IDs", - "operationId": "db-table-row-bulk-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "description": "List of returned values. 1 means successful. 0 means failed.", - "items": { - "x-stoplight": { - "id": "ga0xhsahovdt7" - }, - "type": "number" - } - }, - "examples": { - "Example 1": { - "value": [1, 1] - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Row"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "array", - "description": "List of data objects", - "items": { - "x-stoplight": { - "id": "q2xtbf29i1s5n" - }, - "type": "object" - } - }, - "examples": { - "Example 1": { - "value": [ - { - "Id": "1", - "Title": "123" - }, - { - "Id": "2", - "Title": "456" - } - ] - } - } - } - } - }, - "description": "Bulk Update Table Rows by given IDs", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "delete": { - "summary": "Bulk Delete Table Rows by IDs", - "operationId": "db-table-row-bulk-delete", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "x-stoplight": { - "id": "b9o9o2r6ipho9" - }, - "type": "number" - } - }, - "examples": { - "Example 1": { - "value": [1, 1] - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Row"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "x-stoplight": { - "id": "sd8udhhjnqiay" - }, - "type": "object" - } - }, - "examples": { - "Example 1": { - "value": [ - { - "Id": "1" - }, - { - "Id": "2" - } - ] - } - } - } - }, - "description": "" - }, - "description": "Bulk Delete Table Rows by given IDs", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/data/bulk/{orgs}/{projectName}/{tableName}/all": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where" - } - ], - "patch": { - "summary": "Bulk Update Table Rows with Conditions", - "operationId": "db-table-row-bulk-update-all", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": {}, - "examples": { - "Example 1": { - "value": [ - { - "Id": "1" - }, - { - "Id": "2" - } - ] - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Row"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "examples": { - "Example 1": { - "value": { - "Title": "foo" - } - } - } - } - } - }, - "description": "Bulk Update all Table Rows if the condition is true", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "delete": { - "summary": "Bulk Delete Table Rows with Conditions", - "operationId": "db-table-row-bulk-delete-all", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "x-stoplight": { - "id": "9gcl3ok7is3y0" - }, - "type": "object" - } - }, - "examples": { - "Example 1": { - "value": [1, 1] - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Row"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "examples": { - "Example 1": { - "value": { - "Title": "foo" - } - } - } - } - } - }, - "description": "Bulk Delete all Table Rows if the condition is true", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/views/{viewName}/export/{type}": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "type": "string" - }, - "name": "viewName", - "in": "path", - "required": true - }, - { - "schema": { - "type": "string", - "enum": ["csv", "excel"] - }, - "name": "type", - "in": "path", - "required": true - } - ], - "get": { - "summary": "Export Table View Rows", - "operationId": "db-view-row-export", - "description": "Export Table View Rows by CSV or Excel", - "tags": ["DB View Row"], - "wrapped": true, - "responses": { - "200": { - "description": "OK", - "content": { - "application/octet-stream": { - "schema": {} - } - }, - "headers": { - "nc-export-offset": { - "schema": { - "type": "integer" - }, - "description": "The starting offset of the next set of rows" - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/export/{type}": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "type": "string", - "enum": ["csv", "excel"] - }, - "name": "type", - "in": "path", - "required": true - } - ], - "get": { - "summary": "Export Table View Rows", - "operationId": "db-table-row-csv-export", - "description": "Export Table View Rows by CSV or Excel", - "tags": ["DB Table Row"], - "wrapped": true, - "responses": { - "200": { - "description": "OK", - "content": { - "application/octet-stream": { - "schema": {} - } - }, - "headers": { - "nc-export-offset": { - "schema": { - "type": "integer" - }, - "description": "The starting offset of the next set of rows" - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/{rowId}/{relationType}/{columnName}": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "example": "1" - }, - "name": "rowId", - "in": "path", - "required": true, - "description": "Unique Row ID" - }, - { - "schema": { - "type": "string", - "enum": ["mm", "hm", "bt"] - }, - "name": "relationType", - "in": "path", - "required": true, - "description": "Relation Type" - }, - { - "schema": { - "type": "string" - }, - "name": "columnName", - "in": "path", - "required": true, - "description": "Column Name" - } - ], - "get": { - "summary": "List Nested Relations Rows", - "operationId": "db-table-row-nested-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": {} - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Row"], - "parameters": [ - { - "schema": { - "type": "integer", - "minimum": 1 - }, - "in": "query", - "name": "limit" - }, - { - "schema": { - "type": "integer", - "minimum": 0 - }, - "in": "query", - "name": "offset" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "description": "List all nested relations rows" - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/{rowId}/{relationType}/{columnName}/{refRowId}": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "example": "1" - }, - "name": "rowId", - "in": "path", - "required": true, - "description": "Unique Row ID" - }, - { - "schema": { - "type": "string", - "enum": ["mm", "hm", "bt"] - }, - "name": "relationType", - "in": "path", - "required": true - }, - { - "schema": { - "type": "string" - }, - "name": "columnName", - "in": "path", - "required": true - }, - { - "schema": { - "type": "string" - }, - "name": "refRowId", - "in": "path", - "required": true - } - ], - "post": { - "summary": "Create Nested Relations Row", - "operationId": "db-table-row-nested-add", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "m6jox00hxgd6s" - }, - "example": "The relation data has been created successfully" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "The relation data has been created successfully" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Row"], - "parameters": [ - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "fields", - "description": "Which fields to be shown" - }, - { - "schema": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "type": "string" - } - ] - }, - "in": "query", - "name": "sort", - "description": "The result will be sorted based on `sort` query" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where", - "description": "Extra filtering" - }, - { - "schema": { - "type": "integer", - "minimum": 0 - }, - "in": "query", - "name": "offset", - "description": "Offset in rows" - }, - { - "schema": { - "type": "integer", - "minimum": 1 - }, - "in": "query", - "name": "limit", - "description": "Limit in rows" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "sortArrJson", - "description": "Used for multiple sort queries" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "filterArrJson", - "description": "Used for multiple filter queries" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "description": "Create a new nested relations row" - }, - "delete": { - "summary": "Delete Nested Relations Row", - "operationId": "db-table-row-nested-remove", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "vo3x8xf3j2xlb" - }, - "example": "The relation data has been deleted successfully" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "The relation data has been deleted successfully" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Row"], - "description": "Delete a new nested relations row", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/{rowId}/{relationType}/{columnName}/exclude": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "example": "1" - }, - "name": "rowId", - "in": "path", - "required": true, - "description": "Unique Row ID" - }, - { - "schema": { - "type": "string", - "enum": ["mm", "hm", "bt"] - }, - "name": "relationType", - "in": "path", - "required": true - }, - { - "schema": { - "type": "string" - }, - "name": "columnName", - "in": "path", - "required": true - } - ], - "get": { - "summary": "Referenced Table Rows Excluding Current Record's Children / Parent", - "operationId": "db-table-row-nested-children-excluded-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": {} - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Row"], - "parameters": [ - { - "schema": { - "type": "integer", - "minimum": 1 - }, - "in": "query", - "name": "limit" - }, - { - "schema": { - "type": "integer", - "minimum": 0 - }, - "in": "query", - "name": "offset" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "description": "Get the table rows but exculding the current record's children and parent" - } - }, - "/api/v1/db/public/shared-view/{sharedViewUuid}/group/{columnId}": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "24a6d0bb-e45d-4b1a-bfef-f492d870de9f" - }, - "name": "sharedViewUuid", - "in": "path", - "required": true, - "description": "Shared View UUID" - }, - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "cl_8iw2o4ejzvdyna", - "type": "string" - }, - "name": "columnId", - "in": "path", - "required": true, - "description": "Unique Column ID" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "xc-password", - "description": "Shared view password" - } - ], - "get": { - "summary": "List Shared View Grouped Data", - "operationId": "public-grouped-data-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "x-stoplight": { - "id": "bldcv1pwuri5s" - }, - "type": "object", - "properties": { - "key": { - "type": "string", - "x-stoplight": { - "id": "n0ujmkbyhgsxo" - }, - "description": "The Grouped Key" - }, - "value": { - "type": "object", - "x-stoplight": { - "id": "0xsi3jvwn7duo" - }, - "description": "the paginated result of the given key", - "required": ["list", "pageInfo"], - "properties": { - "list": { - "type": "array", - "x-stoplight": { - "id": "jw8dmo16txbjv" - }, - "description": "List of the target data", - "items": { - "x-stoplight": { - "id": "xcu8vxmf5ygyi" - }, - "type": "object" - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated", - "x-stoplight": { - "id": "1gsbgwi9bg8s5" - }, - "description": "Paginated Info" - } - } - } - }, - "required": ["key", "value"] - } - }, - "examples": { - "Example 1": { - "value": [ - { - "key": "a", - "value": { - "list": [ - { - "Id": 2, - "Title": "foo", - "s": "a" - } - ], - "pageInfo": { - "totalRows": 1, - "page": 1, - "pageSize": 25, - "isFirstPage": true, - "isLastPage": true - } - } - }, - { - "key": "b", - "value": { - "list": [ - { - "Id": 3, - "Title": "bar", - "s": "b" - } - ], - "pageInfo": { - "totalRows": 1, - "page": 1, - "pageSize": 25, - "isFirstPage": true, - "isLastPage": true - } - } - }, - { - "key": null, - "value": { - "list": [ - { - "Id": 1, - "Title": "baz", - "s": null - } - ], - "pageInfo": { - "totalRows": 1, - "page": 1, - "pageSize": 25, - "isFirstPage": true, - "isLastPage": true - } - } - } - ] - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Public"], - "parameters": [ - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "fields", - "description": "Which fields to be shown" - }, - { - "schema": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "type": "string" - } - ] - }, - "in": "query", - "name": "sort", - "description": "The result will be sorted based on `sort` query" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where", - "description": "Extra filtering" - }, - { - "schema": { - "type": "integer", - "minimum": 0 - }, - "in": "query", - "name": "offset", - "description": "Offset in rows" - }, - { - "schema": { - "type": "integer", - "minimum": 1 - }, - "in": "query", - "name": "limit", - "description": "Limit in rows" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "sortArrJson", - "description": "Used for multiple sort queries" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "filterArrJson", - "description": "Used for multiple filter queries" - } - ], - "description": "List Shared View Grouped Data" - } - }, - "/api/v1/db/public/shared-view/{sharedViewUuid}/rows": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "24a6d0bb-e45d-4b1a-bfef-f492d870de9f" - }, - "name": "sharedViewUuid", - "in": "path", - "required": true, - "description": "Shared View UUID" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "xc-password", - "description": "Shared view password" - } - ], - "get": { - "summary": "List Shared View Rows", - "operationId": "public-data-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SharedViewList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:46:31", - "fk_model_id": "md_mhs9z4r2ak98x0", - "id": "vw_lg052cnc1c26kf", - "is_default": 1, - "lock_type": "collaborative", - "meta": {}, - "order": 1, - "password": null, - "project_id": "p_xm3thidrblw4n7", - "show": 1, - "show_system_fields": null, - "title": "Sheet-1", - "type": 3, - "updated_at": "2023-03-02 17:46:31", - "uuid": null, - "view": { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:46:31", - "fk_view_id": "vw_lg052cnc1c26kf", - "meta": null, - "project_id": "p_xm3thidrblw4n7", - "row_height": null, - "updated_at": "2023-03-02 17:46:31", - "uuid": null - } - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Public"], - "parameters": [ - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "fields", - "description": "Which fields to be shown" - }, - { - "schema": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "type": "string" - } - ] - }, - "in": "query", - "name": "sort", - "description": "The result will be sorted based on `sort` query" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where", - "description": "Extra filtering" - }, - { - "schema": { - "type": "integer", - "minimum": 0 - }, - "in": "query", - "name": "offset", - "description": "Offset in rows" - }, - { - "schema": { - "type": "integer", - "minimum": 1 - }, - "in": "query", - "name": "limit", - "description": "Limit in rows" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "sortArrJson", - "description": "Used for multiple sort queries" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "filterArrJson", - "description": "Used for multiple filter queries" - } - ], - "description": "List all shared view rows" - }, - "post": { - "summary": "Create Share View Row", - "operationId": "public-data-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "examples": { - "Example 1": { - "value": { - "Id": 1, - "col1": "foo", - "col2": "bar", - "CreatedAt": "2023-03-11T08:48:25.598Z", - "UpdatedAt": "2023-03-11T08:48:25.598Z" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "multipart/form-data": {} - }, - "description": "" - }, - "tags": ["Public"], - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "xc-password", - "description": "Shared view password" - } - ], - "description": "Create a new row for the target shared view" - } - }, - "/api/v1/db/public/shared-view/{sharedViewUuid}/rows/{rowId}/{relationType}/{columnName}": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "24a6d0bb-e45d-4b1a-bfef-f492d870de9f" - }, - "name": "sharedViewUuid", - "in": "path", - "required": true, - "description": "Shared View UUID" - }, - { - "schema": { - "example": "1" - }, - "name": "rowId", - "in": "path", - "required": true, - "description": "Unique Row ID" - }, - { - "schema": { - "type": "string", - "enum": ["mm", "hm", "bt"] - }, - "name": "relationType", - "in": "path", - "required": true, - "description": "Relation Type" - }, - { - "schema": { - "type": "string" - }, - "name": "columnName", - "in": "path", - "required": true, - "description": "Column Name" - } - ], - "get": { - "summary": "List Nested List Data", - "operationId": "public-data-nested-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "list": { - "type": "array", - "x-stoplight": { - "id": "gvblksjzjfyg7" - }, - "description": "List of data objects", - "items": { - "x-stoplight": { - "id": "8assgoc1vtcs9" - }, - "type": "object" - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated", - "x-stoplight": { - "id": "if546w1yuo6fw" - }, - "description": "Paginated info" - } - }, - "required": ["list", "pageInfo"] - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "Id": 1, - "Title": "foo", - "CreatedAt": "2023-03-11T08:41:41.356Z", - "UpdatedAt": "2023-03-11T08:41:41.356Z" - }, - { - "Id": 2, - "Title": "bar", - "CreatedAt": "2023-03-11T08:41:45.330Z", - "UpdatedAt": "2023-03-11T08:41:45.330Z" - }, - { - "Id": 3, - "Title": "baz", - "CreatedAt": "2023-03-11T08:48:25.598Z", - "UpdatedAt": "2023-03-11T08:48:25.598Z" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "pageSize": 1, - "sort": "string", - "totalRows": 3 - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Public"], - "parameters": [ - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "fields", - "description": "Which fields to be shown" - }, - { - "schema": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "type": "string" - } - ] - }, - "in": "query", - "name": "sort", - "description": "The result will be sorted based on `sort` query" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where", - "description": "Extra filtering" - }, - { - "schema": { - "type": "integer", - "minimum": 0 - }, - "in": "query", - "name": "offset", - "description": "Offset in rows" - }, - { - "schema": { - "type": "integer", - "minimum": 1 - }, - "in": "query", - "name": "limit", - "description": "Limit in rows" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "sortArrJson", - "description": "Used for multiple sort queries" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "filterArrJson", - "description": "Used for multiple filter queries" - } - ], - "description": "List all nested list data in a given shared view" - } - }, - "/api/v1/db/public/shared-view/{sharedViewUuid}/rows/export/{type}": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "76d44b86-bc65-4500-8956-ab512c80ab25" - }, - "name": "sharedViewUuid", - "in": "path", - "required": true, - "description": "Shared View UUID" - }, - { - "schema": { - "type": "string", - "enum": ["csv", "excel"], - "example": "csv" - }, - "name": "type", - "in": "path", - "required": true, - "description": "Export Type" - } - ], - "get": { - "summary": "Export Rows in Share View", - "operationId": "public-csv-export", - "description": "Export all rows in Share View in a CSV / Excel Format", - "wrapped": true, - "responses": { - "200": { - "description": "OK", - "content": { - "application/octet-stream": { - "schema": {} - } - }, - "headers": { - "nc-export-offset": { - "schema": { - "type": "integer" - }, - "description": "The starting offset of the next set of rows" - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Public"] - } - }, - "/api/v1/db/public/shared-view/{sharedViewUuid}/nested/{columnName}": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "24a6d0bb-e45d-4b1a-bfef-f492d870de9f" - }, - "name": "sharedViewUuid", - "in": "path", - "required": true, - "description": "Shared View UUID" - }, - { - "schema": { - "type": "string" - }, - "name": "columnName", - "in": "path", - "required": true, - "description": "Column Name" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "xc-password", - "description": "Shared view password" - } - ], - "get": { - "summary": "List Nested Data Relation", - "operationId": "public-data-relation-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": {} - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "parameters": [ - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "fields", - "description": "Which fields to be shown" - }, - { - "schema": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "type": "string" - } - ] - }, - "in": "query", - "name": "sort", - "description": "The result will be sorted based on `sort` query" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where", - "description": "Extra filtering" - }, - { - "schema": { - "type": "integer", - "minimum": 0 - }, - "in": "query", - "name": "offset", - "description": "Offset in rows" - }, - { - "schema": { - "type": "integer", - "minimum": 1 - }, - "in": "query", - "name": "limit", - "description": "Limit in rows" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "sortArrJson", - "description": "Used for multiple sort queries" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "filterArrJson", - "description": "Used for multiple filter queries" - } - ], - "tags": ["Public"], - "description": "List Nested Data Relation" - } - }, - "/api/v1/db/public/shared-base/{sharedBaseUuid}/meta": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "24a6d0bb-e45d-4b1a-bfef-f492d870de9f" - }, - "name": "sharedBaseUuid", - "in": "path", - "required": true, - "description": "Shared Base UUID" - } - ], - "get": { - "summary": "Get Share Base Meta", - "operationId": "public-shared-base-get", - "description": "Get Share Base Meta", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "project_id": { - "type": "string", - "description": "Project ID" - } - } - }, - "examples": { - "Example 1": { - "value": { - "project_id": "p_63b4q0qengen1x" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Public"] - } - }, - "/api/v1/db/public/shared-view/{sharedViewUuid}/meta": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "24a6d0bb-e45d-4b1a-bfef-f492d870de9f" - }, - "name": "sharedViewUuid", - "in": "path", - "required": true, - "description": "Shared View UUID" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "xc-password", - "description": "Shared view password" - } - ], - "get": { - "summary": "Get Share View Meta", - "operationId": "public-shared-view-meta-get", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/View" - }, - { - "type": "object", - "properties": { - "relatedMetas": {}, - "client": { - "type": "string" - }, - "base_id": { - "type": "string" - }, - "columns": { - "allOf": [ - { - "anyOf": [ - { - "$ref": "#/components/schemas/GridColumn" - }, - { - "$ref": "#/components/schemas/FormColumn" - }, - { - "$ref": "#/components/schemas/GalleryColumn" - } - ] - }, - { - "$ref": "#/components/schemas/Column" - } - ] - }, - "model": { - "$ref": "#/components/schemas/Table" - } - } - }, - { - "type": "object", - "properties": { - "view": { - "anyOf": [ - { - "$ref": "#/components/schemas/Form" - }, - { - "$ref": "#/components/schemas/Grid" - }, - { - "$ref": "#/components/schemas/Gallery" - } - ] - } - } - } - ] - } - }, - "application/xml": { - "schema": {} - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Public"], - "description": "Get Share View Meta" - } - }, - "/api/v1/db/meta/audits/comments": { - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "get": { - "summary": "List Comments in Audit", - "operationId": "utils-comment-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "list": { - "x-stoplight": { - "id": "5zto1xohsngbu" - }, - "type": "array", - "items": { - "$ref": "#/components/schemas/Audit", - "x-stoplight": { - "id": "d22zkup0c0l80" - } - } - } - }, - "required": ["list"] - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "id": "adt_3sii7erfwrlegb", - "user": "w@nocodb.com", - "ip": null, - "base_id": null, - "project_id": "p_63b4q0qengen1x", - "fk_model_id": "md_5mipbdg6ketmv8", - "row_id": "1", - "op_type": "COMMENT", - "op_sub_type": null, - "status": null, - "description": "bar", - "details": null, - "created_at": "2023-03-13T09:39:14.225Z", - "updated_at": "2023-03-13T09:39:14.225Z" - }, - { - "id": "adt_fezs668qbxj8gc", - "user": "w@nocodb.com", - "ip": null, - "base_id": null, - "project_id": "p_63b4q0qengen1x", - "fk_model_id": "md_5mipbdg6ketmv8", - "row_id": "1", - "op_type": "COMMENT", - "op_sub_type": null, - "status": null, - "description": "foo", - "details": null, - "created_at": "2023-03-13T09:39:13.321Z", - "updated_at": "2023-03-13T09:39:13.321Z" - } - ] - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "List all comments", - "parameters": [ - { - "schema": { - "type": "string", - "example": "10" - }, - "in": "query", - "name": "row_id", - "required": true, - "description": "Row ID" - }, - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "md_c6csq89tl37jm5" - }, - "in": "query", - "name": "fk_model_id", - "required": true, - "description": "Foreign Key to Model" - }, - { - "schema": { - "type": "boolean", - "example": true - }, - "in": "query", - "name": "comments_only", - "description": "Is showing comments only?" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["Utils"] - }, - "post": { - "summary": "Comment Rows", - "operationId": "utils-comment-row", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Audit" - }, - "examples": { - "Example 1": { - "value": { - "user": "w@nocodb.com", - "row_id": "1", - "fk_model_id": "md_5mipbdg6ketmv8", - "op_type": "COMMENT", - "description": "qq", - "project_id": "p_63b4q0qengen1x", - "id": "adt_vx58jpp0loo8qy" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CommentReq" - }, - "examples": { - "Example 1": { - "value": { - "description": "This is the comment for the row", - "fk_model_id": "md_ehn5izr99m7d45", - "row_id": "3" - } - } - } - } - } - }, - "tags": ["Utils"], - "description": "Create a new comment in a row. Logged in Audit.", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/audits/{auditId}/comment": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "adt_zlskd6rlf3liay" - }, - "name": "auditId", - "in": "path", - "required": true, - "description": "Audit ID" - }, - { - "name": "xc-auth", - "in": "header", - "required": false, - "schema": { - "type": "string" - }, - "description": "Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN." - } - ], - "patch": { - "summary": "Update Comment in Audit", - "operationId": "utils-comment-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number", - "example": 1 - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - } - }, - "tags": ["Utils"], - "description": "Update comment in Audit", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CommentUpdateReq" - }, - "examples": { - "Example 1": { - "value": { - "description": "This is the comment for the row" - } - } - } - } - } - } - } - }, - "/api/v1/db/meta/audits/comments/count": { - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "get": { - "summary": "Count Comments", - "operationId": "utils-comment-count", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "x-stoplight": { - "id": "ziwcy4va5r1ao" - }, - "type": "object", - "properties": { - "count": { - "type": "string", - "x-stoplight": { - "id": "5r91gkxmaiyv4" - }, - "description": "The number of comments", - "example": "4" - }, - "row_id": { - "type": "string", - "x-stoplight": { - "id": "08sgorhq172sm" - }, - "description": "Row ID", - "example": "1" - } - }, - "required": ["count", "row_id"] - } - }, - "examples": { - "Example 1": { - "value": [ - { - "count": "4", - "row_id": "1" - } - ] - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Return the number of comments in the given query.", - "parameters": [ - { - "in": "query", - "name": "ids", - "required": true, - "description": "Comment IDs" - }, - { - "schema": { - "$ref": "#/components/schemas/Id" - }, - "in": "query", - "name": "fk_model_id", - "required": true, - "description": "Foreign Key to Model" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["Utils"] - } - }, - "/api/v1/db/meta/projects/{projectId}/audits": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - } - ], - "get": { - "summary": "List Audits in Project", - "operationId": "project-audit-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "list": { - "type": "array", - "uniqueItems": true, - "minItems": 1, - "items": { - "$ref": "#/components/schemas/Audit" - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated" - } - }, - "required": ["list", "pageInfo"] - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "List all audit data in the given project", - "parameters": [ - { - "schema": { - "type": "integer", - "minimum": 0 - }, - "in": "query", - "name": "offset" - }, - { - "schema": { - "type": "integer", - "maximum": 1 - }, - "in": "query", - "name": "limit" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["Project"] - } - }, - "/api/v1/db/meta/audits/rows/{rowId}/update": { - "parameters": [ - { - "schema": { - "example": "1" - }, - "name": "rowId", - "in": "path", - "required": true, - "description": "Unique Row ID" - } - ], - "post": { - "summary": "Update Audit Row", - "operationId": "utils-audit-row-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Audit" - }, - "examples": { - "Example 1": { - "value": { - "user": "w@nocodb.com", - "row_id": "1", - "fk_model_id": "md_5mipbdg6ketmv8", - "op_type": "COMMENT", - "description": "Table Sheet-1 : field Column A got changed from foo to bar", - "project_id": "p_63b4q0qengen1x", - "id": "adt_vx58jpp0loo8qy" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Utils"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AuditRowUpdateReq" - }, - "examples": { - "Example 1": { - "value": { - "column_name": "baz", - "fk_model_id": "md_ehn5izr99m7d45", - "row_id": "1", - "prev_value": "foo", - "value": "bar" - } - } - } - } - } - }, - "description": "Update Audit Row", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/tables/{tableId}/hooks": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "md_w9gpnaousnfss1", - "type": "string" - }, - "name": "tableId", - "in": "path", - "required": true, - "description": "Unique Table ID" - } - ], - "get": { - "summary": "List Table Hooks", - "operationId": "db-table-webhook-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HookList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "active": 0, - "async": 0, - "description": "This is my hook description", - "env": "all", - "event": "after", - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "string", - "notification": "{\"type\":\"URL\",\"payload\":{\"method\":\"POST\",\"body\":\"{{ json data }}\",\"headers\":[{}],\"parameters\":[{}],\"auth\":\"\",\"path\":\"http://example.com\"}}", - "null": null, - "operation": "insert", - "retries": 10, - "retry_interval": 60000, - "timeout": 60000, - "title": "My Webhook" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "List all hook records in the given Table", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["DB Table Webhook"] - }, - "post": { - "summary": "Create Table Hook", - "operationId": "db-table-webhook-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Hook" - }, - "examples": { - "Example 1": { - "value": { - "active": 0, - "async": 0, - "description": "This is my hook description", - "env": "all", - "event": "after", - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "string", - "notification": "{\"type\":\"URL\",\"payload\":{\"method\":\"POST\",\"body\":\"{{ json data }}\",\"headers\":[{}],\"parameters\":[{}],\"auth\":\"\",\"path\":\"http://example.com\"}}", - "null": null, - "operation": "insert", - "retries": 10, - "retry_interval": 60000, - "timeout": 60000, - "title": "My Webhook" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Create a hook in the given table", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HookReq" - }, - "examples": { - "Example 1": { - "value": { - "active": 0, - "async": 0, - "description": "This is my hook description", - "env": "all", - "event": "after", - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "string", - "notification": "{\"type\":\"URL\",\"payload\":{\"method\":\"POST\",\"body\":\"{{ json data }}\",\"headers\":[{}],\"parameters\":[{}],\"auth\":\"\",\"path\":\"http://example.com\"}}", - "null": null, - "operation": "insert", - "retries": 10, - "retry_interval": 60000, - "timeout": 60000, - "title": "My Webhook", - "condition": false - } - } - } - } - } - }, - "tags": ["DB Table Webhook"] - } - }, - "/api/v1/db/meta/tables/{tableId}/hooks/test": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "md_w9gpnaousnfss1", - "type": "string" - }, - "name": "tableId", - "in": "path", - "required": true, - "description": "Unique Table ID" - } - ], - "post": { - "summary": "Test Hook", - "operationId": "db-table-webhook-test", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "l5k90tzuvvv1g" - }, - "example": "The hook has been tested successfully" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "The hook has been tested successfully" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Webhook"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HookTestReq" - }, - "examples": { - "Example 1": { - "value": { - "hook": { - "active": 0, - "async": 0, - "description": "This is my hook description", - "env": "all", - "event": "after", - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "string", - "notification": "{\"type\":\"URL\",\"payload\":{\"method\":\"POST\",\"body\":\"{{ json data }}\",\"headers\":[{}],\"parameters\":[{}],\"auth\":\"\",\"path\":\"http://example.com\"}}", - "null": null, - "operation": "insert", - "retries": 10, - "retry_interval": 60000, - "timeout": 60000, - "title": "My Webhook" - }, - "payload": { - "data": { - "Id": 1, - "Title": "Sample Text", - "CreatedAt": "2023-03-03T10:03:06.484Z", - "UpdatedAt": "2023-03-03T10:03:06.484Z", - "attachment": [ - { - "url": "https://nocodb.com/dummy.png", - "title": "image.png", - "mimetype": "image/png", - "size": 0 - } - ], - "f": "Sample Output" - } - } - } - } - } - } - } - }, - "description": "Test the hook in the given Table", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/tables/{tableId}/hooks/samplePayload/{operation}/{version}": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "md_w9gpnaousnfss1", - "type": "string" - }, - "name": "tableId", - "in": "path", - "required": true, - "description": "Unique Table ID" - }, - { - "schema": { - "type": "string", - "enum": [ - "insert", - "update", - "delete", - "bulkInsert", - "bulkUpdate", - "bulkDelete" - ] - }, - "name": "operation", - "in": "path", - "required": true, - "description": "Hook Operation" - }, - { - "schema": { - "type": "string", - "enum": ["v1", "v2"] - }, - "name": "version", - "in": "path", - "required": true, - "description": "Hook Version" - } - ], - "get": { - "summary": "Get Sample Hook Payload", - "operationId": "db-table-webhook-sample-payload-get", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "data": { - "type": "object", - "x-stoplight": { - "id": "qifsikf69hqbl" - }, - "description": "Sample Payload Data" - } - } - }, - "examples": { - "Example 1": { - "value": { - "data": { - "Id": 1, - "Title": "Sample Text", - "CreatedAt": "2023-03-13T04:59:49.363Z", - "UpdatedAt": "2023-03-13T04:59:49.363Z" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Get the sample hook payload", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["DB Table Webhook"] - } - }, - "/api/v1/db/meta/hooks/{hookId}": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "hk_0063k4o1frnxbr" - }, - "name": "hookId", - "in": "path", - "required": true, - "description": "Unique Hook ID" - } - ], - "patch": { - "summary": "Update Hook", - "operationId": "db-table-webhook-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Hook" - }, - "examples": { - "Example 1": { - "value": { - "active": 0, - "async": 0, - "description": "This is my hook description", - "env": "all", - "event": "after", - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "string", - "notification": "{\"type\":\"URL\",\"payload\":{\"method\":\"POST\",\"body\":\"{{ json data }}\",\"headers\":[{}],\"parameters\":[{}],\"auth\":\"\",\"path\":\"http://example.com\"}}", - "null": null, - "operation": "insert", - "retries": 10, - "retry_interval": 60000, - "timeout": 60000, - "title": "My Webhook" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Webhook"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Hook" - }, - "examples": { - "Example 1": { - "value": { - "active": 0, - "async": 0, - "description": "This is my hook description", - "env": "all", - "event": "after", - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "string", - "notification": "{\"type\":\"URL\",\"payload\":{\"method\":\"POST\",\"body\":\"{{ json data }}\",\"headers\":[{}],\"parameters\":[{}],\"auth\":\"\",\"path\":\"http://example.com\"}}", - "null": null, - "operation": "insert", - "retries": 10, - "retry_interval": 60000, - "timeout": 60000, - "title": "My Webhook" - } - } - } - } - } - }, - "description": "Update the exsiting hook by its ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "delete": { - "summary": "Delete Hook", - "operationId": "db-table-webhook-delete", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "boolean" - }, - "examples": { - "Example 1": { - "value": true - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Webhook"], - "description": "Delete the exsiting hook by its ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/plugins": { - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "get": { - "summary": "List Plugins", - "operationId": "plugin-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "list": { - "type": "array", - "uniqueItems": true, - "minItems": 1, - "items": { - "$ref": "#/components/schemas/Plugin" - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "List all plugins", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["Plugin"] - } - }, - "/api/v1/db/meta/plugins/{pluginTitle}/status": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "pluginTitle", - "in": "path", - "required": true, - "description": "Plugin Title" - } - ], - "get": { - "summary": "Get Plugin Status", - "operationId": "plugin-status", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "boolean" - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Check plugin is active or not", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["Plugin"], - "x-internal": false - } - }, - "/api/v1/db/meta/plugins/test": { - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "post": { - "summary": "Test Plugin", - "operationId": "plugin-test", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": {} - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Test if the plugin is working with the given configurations", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["Plugin"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PluginTestReq" - }, - "examples": { - "Example 1": { - "value": { - "title": "Plugin Foo", - "input": "{\"bucket\":\"my-bucket\",\"region\":\"us-west-004\",\"access_key\":\"redacted\",\"access_secret\":\"redacted\"}", - "category": "Email" - } - } - } - } - } - } - } - }, - "/api/v1/db/meta/plugins/{pluginId}": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "pluginId", - "in": "path", - "required": true, - "description": "Plugin ID" - } - ], - "patch": { - "summary": "Update Plugin", - "operationId": "plugin-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": {} - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Plugin"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PluginReq" - } - } - } - }, - "description": "Update the plugin data by ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "x-internal": false - }, - "get": { - "summary": "Get Plugin", - "operationId": "plugin-read", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Plugin" - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Plugin"], - "description": "Get the plugin data by ID", - "x-internal": false - } - }, - "/api/v1/db/meta/connection/test": { - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "post": { - "summary": "Test DB Connection", - "operationId": "utils-test-connection", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "code": { - "type": "number" - }, - "message": { - "type": "string" - }, - "data": { - "type": "object", - "x-stoplight": { - "id": "6orbk04w97ien" - } - } - } - }, - "examples": { - "Example 1": { - "value": { - "code": 0, - "message": "", - "data": {} - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Utils"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "x-examples": { - "Example 1": { - "client": "mysql2", - "connection": { - "host": "localhost", - "port": "3306", - "user": "root", - "password": "password", - "database": null - } - } - }, - "properties": { - "client": { - "description": "DB Type", - "enum": [ - "mssql", - "mysql", - "mysql2", - "oracledb", - "pg", - "snowflake", - "sqlite3" - ], - "example": "mysql2", - "type": "string" - }, - "connection": { - "type": "object", - "properties": { - "host": { - "type": "string" - }, - "port": { - "type": "string" - }, - "user": { - "type": "string" - }, - "password": { - "type": "string" - }, - "database": { - "$ref": "#/components/schemas/StringOrNull" - } - } - } - } - }, - "examples": { - "Example 1": { - "value": { - "client": "mysql2", - "connection": { - "host": "localhost", - "port": "3306", - "user": "root", - "password": "password", - "database": null - } - } - } - } - } - } - }, - "description": "Test the DB Connection", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/url_to_config": { - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "post": { - "summary": "Convert JDBC URL to Config", - "operationId": "utils-url-to-config", - "tags": ["Utils"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "url": { - "type": "string", - "x-stoplight": { - "id": "fgdbmcjjtkky5" - }, - "description": "JDBC URL", - "example": "jdbc:mysql://username:password@localhost:3306/sakila" - } - } - }, - "examples": { - "Example 1": { - "value": { - "url": "jdbc:mysql://username:password@localhost:3306/sakila" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "x-examples": { - "Example 1": { - "client": "mysql2", - "connection": { - "user": "username", - "password": "password", - "database": "sakila", - "host": "localhost", - "port": "3306" - } - } - }, - "properties": { - "client": { - "description": "DB Type", - "enum": [ - "mssql", - "mysql", - "mysql2", - "oracledb", - "pg", - "snowflake", - "sqlite3" - ], - "example": "mysql2", - "type": "string" - }, - "connection": { - "type": "object", - "description": "Connection Config", - "properties": { - "user": { - "type": "string", - "description": "DB User" - }, - "password": { - "type": "string", - "description": "DB Password" - }, - "database": { - "type": "string", - "description": "DB Name" - }, - "host": { - "type": "string", - "description": "DB Host" - }, - "port": { - "type": "string", - "description": "DB Host" - } - } - } - } - }, - "examples": { - "Example 1": { - "value": { - "client": "mysql2", - "connection": { - "user": "username", - "password": "password", - "database": "sakila", - "host": "localhost", - "port": "3306" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Extract XC URL From JDBC and parse to connection config", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/nocodb/info": { - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "get": { - "summary": "Get App Info", - "operationId": "utils-app-info", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "x-examples": { - "Example 1": { - "authType": "jwt", - "projectHasAdmin": true, - "firstUser": false, - "type": "rest", - "googleAuthEnabled": false, - "githubAuthEnabled": false, - "oneClick": false, - "connectToExternalDB": true, - "version": "0.105.3", - "defaultLimit": 25, - "ncMin": false, - "teleEnabled": false, - "auditEnabled": true, - "ncSiteUrl": "http://localhost:8080", - "ee": false, - "ncAttachmentFieldSize": 20971520, - "ncMaxAttachmentsAllowed": 10 - } - }, - "properties": { - "authType": { - "type": "string" - }, - "projectHasAdmin": { - "type": "boolean" - }, - "firstUser": { - "type": "boolean" - }, - "type": { - "type": "string" - }, - "googleAuthEnabled": { - "type": "boolean" - }, - "githubAuthEnabled": { - "type": "boolean" - }, - "oneClick": { - "type": "boolean" - }, - "connectToExternalDB": { - "type": "boolean" - }, - "version": { - "type": "string" - }, - "defaultLimit": { - "type": "number" - }, - "ncMin": { - "type": "boolean" - }, - "teleEnabled": { - "type": "boolean" - }, - "auditEnabled": { - "type": "boolean" - }, - "ncSiteUrl": { - "type": "string" - }, - "ee": { - "type": "boolean" - }, - "ncAttachmentFieldSize": { - "type": "number" - }, - "ncMaxAttachmentsAllowed": { - "type": "number" - }, - "isCloud": { - "type": "boolean", - "x-stoplight": { - "id": "bstdkpky2131f" - } - }, - "automationLogLevel": { - "type": "string", - "x-stoplight": { - "id": "uc3vaotye2eu8" - }, - "enum": ["OFF", "ERROR", "ALL"], - "example": "OFF" - } - } - }, - "examples": { - "Example 1": { - "value": { - "authType": "jwt", - "projectHasAdmin": true, - "firstUser": false, - "type": "rest", - "googleAuthEnabled": false, - "githubAuthEnabled": false, - "oneClick": false, - "connectToExternalDB": true, - "version": "0.105.3", - "defaultLimit": 25, - "ncMin": false, - "teleEnabled": false, - "auditEnabled": true, - "ncSiteUrl": "http://localhost:8080", - "ee": false, - "ncAttachmentFieldSize": 20971520, - "ncMaxAttachmentsAllowed": 10, - "isCloud": false, - "automationLogLevel": "OFF" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Utils"], - "description": "Get the application info such as authType, defaultLimit, version and etc.", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/axiosRequestMake": { - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "post": { - "summary": "Axios Request", - "operationId": "utils-axios-request-make", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {} - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Generic Axios Call", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object" - } - } - } - }, - "tags": ["Utils"], - "x-internal": true, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/version": { - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "get": { - "summary": "Get App Version", - "operationId": "utils-app-version", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "x-examples": { - "Example 1": { - "currentVersion": "0.105.3", - "releaseVersion": "0.105.3" - } - }, - "properties": { - "currentVersion": { - "type": "string", - "description": "Current NocoDB Version", - "example": "0.104.0" - }, - "releaseVersion": { - "type": "string", - "description": "Latest Release Version", - "example": "0.105.3" - } - } - }, - "examples": { - "Example 1": { - "value": { - "currentVersion": "0.104.0", - "releaseVersion": "0.105.3" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Utils"], - "description": "Get the application version", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/health": { - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "get": { - "summary": "Get Application Health Status", - "operationId": "utils-app-health", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "x-examples": { - "Example 1": { - "message": "OK", - "timestamp": 1678702175755, - "uptime": 1618.996877834 - } - }, - "properties": { - "message": { - "type": "string", - "example": "OK" - }, - "timestamp": { - "type": "string", - "example": "1678702175755" - }, - "uptime": { - "type": "string", - "example": "1618.996877834" - } - } - }, - "examples": { - "Example 1": { - "value": { - "message": "OK", - "timestamp": 1678702175755, - "uptime": 1618.996877834 - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Utils"], - "description": "Get Application Health Status", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/aggregated-meta-info": { - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "get": { - "summary": "Get Aggregated Meta Info", - "operationId": "utils-aggregated-meta-info", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "projectCount": { - "type": "integer" - }, - "projects": { - "type": "array", - "items": { - "type": "object", - "properties": { - "tableCount": { - "type": "object", - "properties": { - "table": { - "type": "integer", - "description": "Table Count" - }, - "view": { - "type": "integer", - "description": "View Count" - } - } - }, - "external": { - "type": "boolean", - "description": "External Project", - "default": false - }, - "viewCount": { - "type": "object", - "properties": { - "formCount": { - "type": "integer", - "description": "Form Count" - }, - "gridCount": { - "type": "integer", - "description": "Grid Count" - }, - "galleryCount": { - "type": "integer", - "description": "Gallery Count" - }, - "kanbanCount": { - "type": "integer", - "description": "Kanban Count" - }, - "total": { - "type": "integer", - "description": "Total View Count" - }, - "sharedFormCount": { - "type": "integer", - "description": "Shared Form Count" - }, - "sharedGridCount": { - "type": "integer", - "description": "Shared Grid Count" - }, - "sharedGalleryCount": { - "type": "integer", - "description": "Shared Gallery Count" - }, - "sharedKanbanCount": { - "type": "integer", - "description": "Shared Kanban Count" - }, - "sharedTotal": { - "type": "integer", - "description": "Shared Total View Count" - }, - "sharedLockedCount": { - "type": "integer", - "description": "Shared Locked View Count" - } - } - }, - "webhookCount": { - "type": "integer", - "description": "Webhook Count" - }, - "filterCount": { - "type": "integer", - "description": "Filter Count" - }, - "sortCount": { - "type": "integer", - "description": "Sort Count" - }, - "rowCount": { - "type": "array", - "items": { - "type": "object", - "properties": { - "TotalRecords": { - "type": "string" - } - } - }, - "description": "Row Count" - }, - "userCount": { - "type": "integer", - "description": "Total project user Count" - } - } - } - }, - "userCount": { - "type": "integer", - "description": "Total user Count" - }, - "sharedBaseCount": { - "type": "integer", - "description": "Total shared base Count" - } - }, - "x-examples": { - "Example 1": { - "projectCount": 1, - "projects": [ - { - "tableCount": { - "table": 3, - "view": 0 - }, - "external": false, - "viewCount": { - "formCount": 0, - "gridCount": 3, - "galleryCount": 0, - "kanbanCount": 0, - "total": 3, - "sharedFormCount": 0, - "sharedGridCount": 0, - "sharedGalleryCount": 0, - "sharedKanbanCount": 0, - "sharedTotal": 0, - "sharedLockedCount": 0 - }, - "webhookCount": 0, - "filterCount": 0, - "sortCount": 0, - "rowCount": [ - { - "TotalRecords": "76" - } - ], - "userCount": 1 - } - ], - "userCount": 1, - "sharedBaseCount": 0 - } - } - }, - "examples": { - "example-1": { - "value": { - "projectCount": 1, - "projects": [ - { - "tableCount": { - "table": 3, - "view": 0 - }, - "external": false, - "viewCount": { - "formCount": 0, - "gridCount": 3, - "galleryCount": 0, - "kanbanCount": 0, - "total": 3, - "sharedFormCount": 0, - "sharedGridCount": 0, - "sharedGalleryCount": 0, - "sharedKanbanCount": 0, - "sharedTotal": 0, - "sharedLockedCount": 0 - }, - "webhookCount": 0, - "filterCount": 0, - "sortCount": 0, - "rowCount": [ - { - "TotalRecords": "76" - } - ], - "userCount": 1 - } - ], - "userCount": 1, - "sharedBaseCount": 0 - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Utils"], - "description": "Get Aggregated Meta Info such as tableCount, dbViewCount, viewCount and etc.", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/cache": { - "get": { - "summary": "Get Cache", - "tags": ["Utils"], - "responses": {}, - "operationId": "utils-cache-get", - "description": "Get All K/V pairs in NocoCache", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "delete": { - "summary": "Delete Cache", - "operationId": "utils-cache-delete", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "boolean" - }, - "examples": { - "Example 1": { - "value": true - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Delete All K/V pairs in NocoCache", - "tags": ["Utils"], - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "/api/v1/db/meta/projects/{projectId}/api-tokens": { - "get": { - "summary": "List API Tokens in Project", - "tags": ["API Token"], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiTokenList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "id": "1", - "fk_user_id": "us_b3xo2i44nx5y9l", - "description": "This API Token is for ABC application", - "token": "DYh540o8hbWpUGdarekECKLdN5OhlgCUWutVJYX2" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "operationId": "api-token-list", - "description": "List API Tokens in the given project", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "post": { - "summary": "Create API Token", - "operationId": "api-token-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiToken" - }, - "examples": { - "Example 1": { - "value": { - "id": "1", - "fk_user_id": "us_b3xo2i44nx5y9l", - "description": "This API Token is for ABC application", - "token": "DYh540o8hbWpUGdarekECKLdN5OhlgCUWutVJYX2" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiTokenReq" - }, - "examples": { - "Example 1": { - "value": { - "description": "This API token is for ABC application" - } - } - } - } - }, - "description": "" - }, - "tags": ["API Token"], - "description": "Create API Token in a project", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - } - ] - }, - "/api/v1/db/meta/projects/{projectId}/api-tokens/{token}": { - "delete": { - "summary": "Delete API Token", - "operationId": "api-token-delete", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number", - "example": 1 - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["API Token"], - "description": "Delete the given API Token in project", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - }, - { - "schema": { - "type": "string", - "example": "DYh540o8hbWpUGdarekECKLdN5OhlgCUWutVJYX2" - }, - "name": "token", - "in": "path", - "required": true, - "description": "API Token" - } - ] - }, - "/api/v1/db/storage/upload": { - "post": { - "summary": "Attachment Upload", - "operationId": "storage-upload", - "responses": {}, - "tags": ["Storage"], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "$ref": "#/components/schemas/AttachmentReq" - }, - "examples": { - "Example 1": { - "value": { - "mimetype": "image/jpeg", - "path": "download/noco/jango_fett/Table1/attachment/uVbjPVQxC_SSfs8Ctx.jpg", - "size": 13052, - "title": "22bc-kavypmq4869759 (1).jpg" - } - } - } - } - }, - "description": "" - }, - "parameters": [ - { - "schema": { - "type": "string", - "example": "download/noco/jango_fett/Table1/attachment/uVbjPVQxC_SSfs8Ctx.jpg" - }, - "name": "path", - "in": "query", - "required": true, - "description": "Target File Path" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "description": "Upload attachment" - } - }, - "/api/v1/db/storage/upload-by-url": { - "post": { - "summary": "Attachment Upload by URL", - "operationId": "storage-upload-by-url", - "responses": {}, - "tags": ["Storage"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AttachmentReq" - } - }, - "examples": {} - } - } - }, - "parameters": [ - { - "schema": { - "type": "string", - "example": "download/noco/jango_fett/Table1/attachment/c7z_UF8sZBgJUxMjpN.jpg" - }, - "name": "path", - "in": "query", - "description": "Target File Path", - "required": true - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "description": "Upload attachment by URL. Used in Airtable Migration." - } - }, - "/api/v1/db/meta/projects/{projectId}/users/{userId}/resend-invite": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - }, - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "us_b3xo2i44nx5y9l" - }, - "name": "userId", - "in": "path", - "required": true, - "description": "Unique User ID" - } - ], - "post": { - "summary": "Resend User Invitation", - "operationId": "auth-project-user-resend-invite", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "m570oh5j3afjt" - }, - "description": "Success Message", - "example": "The invitation has been sent to the user" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "The invitation has been sent to the user" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Auth"], - "description": "Resend Invitation to a specific user", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - } - }, - "components": { - "schemas": { - "ApiToken": { - "description": "Model for API Token", - "examples": [ - { - "id": "1", - "fk_user_id": "us_b3xo2i44nx5y9l", - "description": "This API Token is for ABC application", - "token": "DYh540o8hbWpUGdarekECKLdN5OhlgCUWutVJYX2" - } - ], - "title": "API Token Model", - "type": "object", - "properties": { - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique API Token ID" - }, - "fk_user_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to User" - }, - "description": { - "type": "string", - "description": "API Token Description", - "example": "This API Token is for ABC application" - }, - "token": { - "type": "string", - "description": "API Token", - "example": "DYh540o8hbWpUGdarekECKLdN5OhlgCUWutVJYX2" - } - }, - "x-stoplight": { - "id": "95rfb0httdmw0" - } - }, - "ApiTokenReq": { - "description": "Model for API Token Request", - "examples": [ - { - "description": "This API token is for ABC application" - } - ], - "title": "API Token Request Model", - "type": "object", - "properties": { - "description": { - "description": "Description of the API token", - "maxLength": 255, - "type": "string", - "example": "This API Token is for ABC application" - } - }, - "x-stoplight": { - "id": "h3g2houpa6y9y" - } - }, - "ApiTokenList": { - "description": "Model for API Token List", - "x-stoplight": { - "id": "35b7cvjplxmfm" - }, - "examples": [ - { - "list": [ - { - "id": "1", - "fk_user_id": "us_b3xo2i44nx5y9l", - "description": "This API Token is for ABC application", - "token": "DYh540o8hbWpUGdarekECKLdN5OhlgCUWutVJYX2" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - ], - "title": "API Token List Model", - "type": "object", - "properties": { - "list": { - "type": "array", - "example": [ - { - "list": [ - { - "id": "1", - "fk_user_id": "us_b3xo2i44nx5y9l", - "description": "This API Token is for ABC application", - "token": "DYh540o8hbWpUGdarekECKLdN5OhlgCUWutVJYX2" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - ], - "x-stoplight": { - "id": "c7xu43yjgyjww" - }, - "description": "List of api token objects", - "items": { - "$ref": "#/components/schemas/ApiToken", - "x-stoplight": { - "id": "5ih4l0ix2tr5q" - } - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated", - "x-stoplight": { - "id": "0w8ktfnx3pusz" - }, - "description": "Model for Paginated" - } - }, - "required": ["list", "pageInfo"] - }, - "Attachment": { - "description": "Model for Attachment", - "examples": [ - { - "data": null, - "mimetype": "image/jpeg", - "path": "download/noco/jango_fett/Table1/attachment/c7z_UF8sZBgJUxMjpN.jpg", - "size": 12345, - "title": "kavypmq4869759.jpg" - } - ], - "title": "Attachment Model", - "type": "object", - "properties": { - "data": { - "description": "Data for uploading" - }, - "mimetype": { - "type": "string", - "description": "The mimetype of the attachment" - }, - "path": { - "type": "string", - "description": "File Path" - }, - "size": { - "type": "number", - "description": "Attachment Size" - }, - "title": { - "type": "string", - "description": "The title of the attachment. Used in UI." - }, - "url": { - "type": "string", - "description": "Attachment URL" - } - }, - "x-stoplight": { - "id": "pbx8hqgwdz7lw" - } - }, - "AttachmentReq": { - "description": "Model for Attachment Request", - "type": "object", - "x-examples": { - "Example 1": { - "mimetype": "image/jpeg", - "path": "download/noco/jango_fett/Table1/attachment/uVbjPVQxC_SSfs8Ctx.jpg", - "size": 13052, - "title": "22bc-kavypmq4869759 (1).jpg" - } - }, - "title": "Attachment Request Model", - "properties": { - "mimetype": { - "type": "string", - "description": "The mimetype of the attachment" - }, - "path": { - "type": "string", - "description": "The file path of the attachment" - }, - "size": { - "type": "number", - "description": "The size of the attachment" - }, - "title": { - "type": "string", - "description": "The title of the attachment used in UI" - }, - "url": { - "type": "string", - "description": "Attachment URL to be uploaded via upload-by-url" - } - }, - "x-stoplight": { - "id": "jmahtr8c5rw7f" - } - }, - "Audit": { - "description": "Model for Audit", - "examples": [ - { - "id": "adt_l5we7pkx70vaao", - "user": "w@nocodb.com", - "ip": "::ffff:127.0.0.1", - "base_id": "ds_3l9qx8xqksenrl", - "project_id": "p_9sx43moxhqtjm3", - "fk_model_id": "md_ehn5izr99m7d45", - "row_id": "rec0Adp9PMG9o7uJy", - "op_type": "AUTHENTICATION", - "op_sub_type": "UPDATE", - "status": "string", - "description": "Table nc_snms___Table_1 : field Date got changed from 2023-03-12 to ", - "details": "Date : 2023-03-12 " - } - ], - "title": "Audit Model", - "type": "object", - "properties": { - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "user": { - "type": "string", - "description": "The user name performing the action", - "example": "w@nocodb.com" - }, - "ip": { - "type": "string", - "example": "::ffff:127.0.0.1", - "description": "IP address from the user" - }, - "base_id": { - "type": "string", - "description": "Base ID in where action is performed", - "example": "ds_3l9qx8xqksenrl" - }, - "project_id": { - "type": "string", - "description": "Project ID in where action is performed", - "example": "p_9sx43moxhqtjm3" - }, - "fk_model_id": { - "type": "string", - "description": "Model ID in where action is performed", - "example": "md_ehn5izr99m7d45" - }, - "row_id": { - "type": "string", - "description": "Row ID", - "example": "rec0Adp9PMG9o7uJy" - }, - "op_type": { - "type": "string", - "description": "Operation Type", - "example": "AUTHENTICATION", - "enum": [ - "COMMENT", - "DATA", - "PROJECT", - "VIRTUAL_RELATION", - "RELATION", - "TABLE_VIEW", - "TABLE", - "VIEW", - "META", - "WEBHOOKS", - "AUTHENTICATION", - "TABLE_COLUMN", - "ORG_USER" - ] - }, - "op_sub_type": { - "type": "string", - "description": "Operation Sub Type", - "example": "UPDATE", - "enum": [ - "UPDATE", - "INSERT", - "BULK_INSERT", - "BULK_UPDATE", - "BULK_DELETE", - "LINK_RECORD", - "UNLINK_RECORD", - "DELETE", - "CREATE", - "RENAME", - "IMPORT_FROM_ZIP", - "EXPORT_TO_FS", - "EXPORT_TO_ZIP", - "SIGNIN", - "SIGNUP", - "PASSWORD_RESET", - "PASSWORD_FORGOT", - "PASSWORD_CHANGE", - "EMAIL_VERIFICATION", - "ROLES_MANAGEMENT", - "INVITE", - "RESEND_INVITE" - ] - }, - "status": { - "type": "string", - "description": "Audit Status" - }, - "description": { - "type": "string", - "description": "Description of the action", - "example": "Table nc_snms___Table_1 : field Date got changed from 2023-03-12 to " - }, - "details": { - "type": "string", - "description": "Detail", - "example": "Date : 2023-03-12 " - } - }, - "x-stoplight": { - "id": "i5ug0n7j1wub8" - } - }, - "AuditRowUpdateReq": { - "description": "Model for Audit Row Update Request", - "examples": [ - { - "column_name": "baz", - "fk_model_id": "md_ehn5izr99m7d45", - "row_id": "rec0Adp9PMG9o7uJy", - "prev_value": "foo", - "value": "bar" - } - ], - "title": "Audit Row Update Request Model", - "type": "object", - "properties": { - "column_name": { - "type": "string", - "description": "Column Name", - "example": "baz" - }, - "fk_model_id": { - "type": "string", - "description": "Foreign Key to Model", - "example": "md_ehn5izr99m7d45" - }, - "row_id": { - "type": "string", - "example": "rec0Adp9PMG9o7uJy", - "description": "Row ID" - }, - "prev_value": { - "description": "The previous value before the action" - }, - "value": { - "description": "The current value after the action" - } - }, - "x-stoplight": { - "id": "jcw57b1yv3xog" - } - }, - "Base": { - "description": "Model for Base", - "examples": [ - { - "alias": null, - "config": "", - "enabled": 1, - "id": "ds_krsappzu9f8vmo", - "inflection_column": "camelize", - "inflection_table": "camelize", - "is_meta": 1, - "meta": null, - "order": 1, - "project_id": "p_01clqvzik3izk6", - "type": "mysql2" - } - ], - "title": "Base Model", - "type": "object", - "properties": { - "alias": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Base Name - Default BASE will be null by default" - }, - "config": { - "description": "Base Configuration" - }, - "enabled": { - "$ref": "#/components/schemas/Bool", - "description": "Is this base enabled" - }, - "id": { - "description": "Unique Base ID", - "type": "string" - }, - "inflection_column": { - "description": "Inflection for columns", - "example": "camelize", - "type": "string" - }, - "inflection_table": { - "description": "Inflection for tables", - "example": "camelize", - "type": "string" - }, - "is_meta": { - "$ref": "#/components/schemas/Bool", - "description": "Is the data source connected externally" - }, - "order": { - "description": "The order of the list of bases", - "example": 1, - "type": "number" - }, - "project_id": { - "description": "The project ID that this base belongs to", - "type": "string" - }, - "type": { - "description": "DB Type", - "enum": [ - "mssql", - "mysql", - "mysql2", - "oracledb", - "pg", - "snowflake", - "sqlite3" - ], - "example": "mysql2", - "type": "string" - } - }, - "x-stoplight": { - "id": "9hy3cgp0r2c95" - } - }, - "BaseList": { - "description": "Model for Base List", - "examples": [ - { - "list": [ - { - "alias": null, - "config": "", - "enabled": 1, - "id": "ds_krsappzu9f8vmo", - "inflection_column": "camelize", - "inflection_table": "camelize", - "is_meta": 1, - "meta": null, - "order": 1, - "project_id": "p_01clqvzik3izk6", - "type": "mysql2" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - ], - "title": "Base List Model", - "type": "object", - "x-examples": { - "example-1": { - "bases": { - "list": [ - { - "alias": "sakila", - "config": "", - "created_at": "2023-03-02 11:28:17", - "enabled": 1, - "id": "ds_btbdt19zde0gj9", - "inflection_column": "camelize", - "inflection_table": "camelize", - "is_meta": null, - "meta": null, - "order": 2, - "project_id": "p_01clqvzik3izk6", - "type": "mysql2", - "updated_at": "2023-03-02 11:28:17" - }, - { - "alias": null, - "config": "", - "created_at": "2023-03-01 16:31:49", - "enabled": 1, - "id": "ds_krsappzu9f8vmo", - "inflection_column": "camelize", - "inflection_table": "camelize", - "is_meta": 1, - "meta": null, - "order": 1, - "project_id": "p_01clqvzik3izk6", - "type": "mysql2", - "updated_at": "2023-03-02 11:28:17" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 2, - "totalRows": 2 - } - } - } - }, - "properties": { - "list": { - "type": "array", - "x-stoplight": { - "id": "1q3ny60j1g4z2" - }, - "description": "List of base objects", - "items": { - "$ref": "#/components/schemas/Base", - "x-stoplight": { - "id": "udd0nrcv6pq8d" - } - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated", - "x-stoplight": { - "id": "xqwcniocq37hk" - }, - "description": "Paginated Info" - } - }, - "required": ["list", "pageInfo"], - "x-stoplight": { - "id": "kk8uqxeefumma" - } - }, - "BaseReq": { - "description": "Model for Base Request", - "examples": [ - { - "alias": "My Base", - "config": null, - "inflection_column": "camelize", - "inflection_table": "camelize", - "is_meta": true, - "type": "mysql" - } - ], - "properties": { - "alias": { - "description": "Base Name - Default BASE will be null by default", - "example": "My Base", - "maxLength": 128, - "type": "string" - }, - "config": { - "description": "Base Configuration" - }, - "inflection_column": { - "description": "Inflection for columns", - "example": "camelize", - "type": "string" - }, - "inflection_table": { - "description": "Inflection for tables", - "example": "camelize", - "type": "string" - }, - "is_meta": { - "description": "Is the data source connected externally", - "type": "boolean" - }, - "type": { - "description": "DB Type", - "enum": [ - "mssql", - "mysql", - "mysql2", - "oracledb", - "pg", - "snowflake", - "sqlite3" - ], - "type": "string" - } - }, - "title": "Base Request", - "type": "object", - "x-stoplight": { - "id": "j2z6ain3204zi" - } - }, - "Bool": { - "description": "Model for Bool", - "examples": [true], - "oneOf": [ - { - "description": "0 or 1", - "example": 0, - "type": "integer" - }, - { - "description": "true or false", - "type": "boolean" - }, - { - "type": "null" - } - ], - "title": "Bool Model", - "x-stoplight": { - "id": "8n3vnyr22sbvj" - } - }, - "Column": { - "description": "Model for Column", - "examples": [ - { - "ai": 0, - "au": 0, - "base_id": "ds_krsappzu9f8vmo", - "cc": "", - "cdf": null, - "clen": "45", - "column_name": "title", - "cop": "2", - "created_at": "2023-03-02 13:14:16", - "csn": "utf8mb4", - "ct": "varchar(45)", - "deleted": null, - "dt": "varchar", - "dtx": "specificType", - "dtxp": "45", - "dtxs": null, - "fk_model_id": "md_yvwvbt2i78rgcm", - "id": "cl_0j9gv0oi8vjy46", - "meta": null, - "np": null, - "ns": null, - "order": 2, - "pk": 0, - "project_id": "p_01clqvzik3izk6", - "pv": 1, - "rqd": 0, - "system": 0, - "title": "Title", - "uidt": "SingleLineText", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 13:14:16", - "validate": null, - "virtual": null - } - ], - "title": "Column Model", - "type": "object", - "properties": { - "ai": { - "$ref": "#/components/schemas/Bool", - "description": "Is Auto-Increment?" - }, - "au": { - "$ref": "#/components/schemas/Bool", - "description": "Auto Update Timestamp" - }, - "base_id": { - "description": "Base ID that this column belongs to", - "example": "ds_krsappzu9f8vmo", - "type": "string" - }, - "cc": { - "description": "Column Comment", - "type": "string" - }, - "cdf": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Column Default" - }, - "clen": { - "description": "Character Maximum Length", - "oneOf": [ - { - "type": "integer" - }, - { - "type": "null" - }, - { - "type": "string" - } - ] - }, - "colOptions": { - "anyOf": [ - { - "$ref": "#/components/schemas/Formula" - }, - { - "$ref": "#/components/schemas/LinkToAnotherRecord" - }, - { - "$ref": "#/components/schemas/Lookup" - }, - { - "$ref": "#/components/schemas/Rollup" - }, - { - "$ref": "#/components/schemas/SelectOptions" - }, - { - "type": "object" - } - ], - "description": "Column Options" - }, - "column_name": { - "description": "Column Name", - "example": "title", - "type": "string" - }, - "cop": { - "description": "Column Ordinal Position", - "type": "string" - }, - "csn": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Character Set Name" - }, - "ct": { - "description": "Column Type", - "example": "varchar(45)", - "type": "string" - }, - "deleted": { - "$ref": "#/components/schemas/Bool", - "description": "Is Deleted?" - }, - "dt": { - "description": "Data Type in DB", - "example": "varchar", - "type": "string" - }, - "dtx": { - "description": "Data Type X", - "example": "specificType", - "type": "string" - }, - "dtxp": { - "description": "Data Type X Precision", - "oneOf": [ - { - "type": "null" - }, - { - "type": "number" - }, - { - "type": "string" - } - ] - }, - "dtxs": { - "description": "Data Type X Scale", - "oneOf": [ - { - "type": "null" - }, - { - "type": "number" - }, - { - "type": "string" - } - ] - }, - "fk_model_id": { - "description": "Model ID that this column belongs to", - "example": "md_yvwvbt2i78rgcm", - "type": "string" - }, - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "description": "Meta Info" - }, - "np": { - "description": "Numeric Precision", - "oneOf": [ - { - "type": "integer" - }, - { - "type": "null" - }, - { - "type": "string" - } - ] - }, - "ns": { - "description": "Numeric Scale", - "oneOf": [ - { - "type": "integer" - }, - { - "type": "null" - }, - { - "type": "string" - } - ] - }, - "order": { - "description": "The order of the list of columns", - "type": "number" - }, - "pk": { - "$ref": "#/components/schemas/Bool", - "description": "Is Primary Key?" - }, - "pv": { - "$ref": "#/components/schemas/Bool", - "description": "Is Primary Value?" - }, - "rqd": { - "$ref": "#/components/schemas/Bool", - "description": "Is Required?" - }, - "system": { - "$ref": "#/components/schemas/Bool", - "description": "Is System Column?" - }, - "title": { - "description": "Column Title", - "example": "Title", - "type": "string" - }, - "uidt": { - "description": "The data type in UI", - "example": "SingleLineText", - "enum": [ - "Attachment", - "AutoNumber", - "Barcode", - "Button", - "Checkbox", - "Collaborator", - "Count", - "CreateTime", - "Currency", - "Date", - "DateTime", - "Decimal", - "Duration", - "Email", - "Formula", - "ForeignKey", - "GeoData", - "Geometry", - "ID", - "JSON", - "LastModifiedTime", - "LongText", - "LinkToAnotherRecord", - "Lookup", - "MultiSelect", - "Number", - "Percent", - "PhoneNumber", - "Rating", - "Rollup", - "SingleLineText", - "SingleSelect", - "SpecificDBType", - "Time", - "URL", - "Year", - "QrCode" - ], - "type": "string" - }, - "un": { - "$ref": "#/components/schemas/Bool", - "description": "Is Unsigned?" - }, - "unique": { - "$ref": "#/components/schemas/Bool", - "description": "Is unique?" - }, - "visible": { - "$ref": "#/components/schemas/Bool", - "description": "Is Visible?" - } - }, - "x-stoplight": { - "id": "3a4lsn477mx4e" - } - }, - "ColumnList": { - "description": "Model for Column List", - "examples": [ - { - "list": [ - { - "ai": 0, - "au": 0, - "base_id": "ds_krsappzu9f8vmo", - "cc": "", - "cdf": null, - "clen": "45", - "column_name": "title", - "cop": "2", - "created_at": "2023-03-02 13:14:16", - "csn": "utf8mb4", - "ct": "varchar(45)", - "deleted": null, - "dt": "varchar", - "dtx": "specificType", - "dtxp": "45", - "dtxs": null, - "fk_model_id": "md_yvwvbt2i78rgcm", - "id": "cl_0j9gv0oi8vjy46", - "meta": null, - "np": null, - "ns": null, - "order": 2, - "pk": 0, - "project_id": "p_01clqvzik3izk6", - "pv": 1, - "rqd": 0, - "system": 0, - "title": "Title", - "uidt": "SingleLineText", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 13:14:16", - "validate": null, - "virtual": null - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - ], - "title": "Column List Model", - "type": "object", - "x-examples": { - "example-1": { - "bases": { - "list": [ - { - "alias": "string", - "database": "string", - "host": "string", - "id": "string", - "params": "string", - "password": "string", - "port": 0, - "project_id": "string", - "ssl": "string", - "type": "string", - "url": "string", - "username": "string" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "pageSize": 0, - "sort": "string", - "totalRows": 0 - } - } - } - }, - "properties": { - "list": { - "type": "array", - "x-stoplight": { - "id": "c6lpw8px25356" - }, - "description": "List of column objects", - "items": { - "$ref": "#/components/schemas/Column", - "x-stoplight": { - "id": "zbm89i86dr73y" - } - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated", - "x-stoplight": { - "id": "ko0s0z13h4hsw" - } - } - }, - "required": ["list", "pageInfo"], - "x-stoplight": { - "id": "rldg44w1alasg" - } - }, - "ColumnReq": { - "allOf": [ - { - "anyOf": [ - { - "$ref": "#/components/schemas/FormulaColumnReq" - }, - { - "$ref": "#/components/schemas/LinkToAnotherColumnReq" - }, - { - "$ref": "#/components/schemas/LookupColumnReq" - }, - { - "$ref": "#/components/schemas/NormalColumnRequest" - }, - { - "$ref": "#/components/schemas/RollupColumnReq" - } - ] - }, - { - "properties": { - "column_name": { - "type": "string" - }, - "column_order": { - "description": "Column order in a specific view", - "properties": { - "order": { - "type": "number" - }, - "view_id": { - "type": "string" - } - }, - "type": "object" - }, - "title": { - "maxLength": 255, - "minLength": 1, - "type": "string" - } - }, - "required": ["title"] - } - ], - "description": "Model for Column Request", - "examples": [ - { - "ai": 0, - "au": 0, - "base_id": "ds_krsappzu9f8vmo", - "cc": "", - "cdf": null, - "clen": "45", - "column_name": "title", - "cop": "2", - "created_at": "2023-03-02 13:14:16", - "csn": "utf8mb4", - "ct": "varchar(45)", - "deleted": null, - "dt": "varchar", - "dtx": "specificType", - "dtxp": "45", - "dtxs": null, - "fk_model_id": "md_yvwvbt2i78rgcm", - "id": "cl_0j9gv0oi8vjy46", - "meta": null, - "np": null, - "ns": null, - "order": 2, - "pk": 0, - "project_id": "p_01clqvzik3izk6", - "pv": 1, - "rqd": 0, - "system": 0, - "title": "Title", - "uidt": "SingleLineText", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 13:14:16", - "validate": null, - "virtual": null - } - ], - "title": "Column Request Model", - "type": "object", - "x-stoplight": { - "id": "dvbn9dnme6jgi" - } - }, - "CommentReq": { - "description": "Model for Comment Request", - "examples": [ - { - "description": "This is the comment for the row", - "fk_model_id": "md_ehn5izr99m7d45", - "row_id": "3" - } - ], - "title": "Comment Request Model", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Description for the target row", - "example": "This is the comment for the row" - }, - "fk_model_id": { - "type": "string", - "description": "Foreign Key to Model", - "example": "md_ehn5izr99m7d45" - }, - "row_id": { - "type": "string", - "description": "Row ID", - "example": "3" - } - }, - "required": ["fk_model_id", "row_id"], - "x-stoplight": { - "id": "7nwlyinuliuvy" - } - }, - "CommentUpdateReq": { - "description": "Model for Comment Update Request", - "x-stoplight": { - "id": "r0f3ng2rahe38" - }, - "examples": [ - { - "description": "This is the comment for the row" - } - ], - "title": "Comment Update Request Model", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Description for the target row", - "example": "This is the comment for the row" - } - } - }, - "Filter": { - "description": "Model for Filter", - "examples": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "comparison_op": "eq", - "comparison_sub_op": null, - "created_at": "2023-03-02 18:18:05", - "fk_column_id": "cl_d7ah9n2qfupgys", - "fk_hook_id": null, - "fk_parent_id": null, - "fk_view_id": "vw_b739e29vqmrxnf", - "id": "fi_xn647tpmdq8fu8", - "is_group": null, - "logical_op": "and", - "order": 1, - "project_id": "p_xm3thidrblw4n7", - "updated_at": "2023-03-02 18:18:05", - "value": "foo" - } - ], - "properties": { - "base_id": { - "description": "Unqiue Base ID", - "readOnly": true, - "type": "string" - }, - "children": { - "description": "Children filters. Available when the filter is grouped.", - "items": { - "$ref": "#/components/schemas/Filter" - }, - "type": "array" - }, - "comparison_op": { - "description": "Comparison Operator", - "enum": [ - "allof", - "anyof", - "blank", - "btw", - "checked", - "empty", - "eq", - "ge", - "gt", - "gte", - "in", - "is", - "isWithin", - "isnot", - "le", - "like", - "lt", - "lte", - "nallof", - "nanyof", - "nbtw", - "neq", - "nlike", - "not", - "notblank", - "notchecked", - "notempty", - "notnull", - "null" - ], - "type": "string" - }, - "comparison_sub_op": { - "anyOf": [ - { - "enum": [ - "daysAgo", - "daysFromNow", - "exactDate", - "nextMonth", - "nextNumberOfDays", - "nextWeek", - "nextYear", - "oneMonthAgo", - "oneMonthFromNow", - "oneWeekAgo", - "oneWeekFromNow", - "pastMonth", - "pastNumberOfDays", - "pastWeek", - "pastYear", - "today", - "tomorrow", - "yesterday" - ], - "type": "string" - }, - { - "type": "null" - } - ], - "description": "Comparison Sub-Operator" - }, - "fk_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Column" - }, - "fk_hook_id": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Foreign Key to Hook" - }, - "fk_model_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Model" - }, - "fk_parent_id": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Foreign Key to parent group." - }, - "fk_view_id": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Foreign Key to View" - }, - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "is_group": { - "description": "Is this filter grouped?", - "oneOf": [ - { - "type": "boolean" - }, - { - "type": "integer" - }, - { - "type": "null" - } - ] - }, - "logical_op": { - "description": "Logical Operator", - "enum": ["and", "not", "or"], - "type": "string" - }, - "project_id": { - "description": "Unique Project ID", - "readOnly": true, - "type": "string" - }, - "value": { - "description": "The filter value. Can be NULL for some operators." - } - }, - "readOnly": true, - "title": "Filter Model", - "type": "object", - "x-stoplight": { - "id": "f8vsb8alix01i" - } - }, - "FilterList": { - "description": "Model for Filter List", - "examples": [ - { - "list": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "comparison_op": "eq", - "comparison_sub_op": null, - "created_at": "2023-03-02 18:18:05", - "fk_column_id": "cl_d7ah9n2qfupgys", - "fk_hook_id": null, - "fk_parent_id": null, - "fk_view_id": "vw_b739e29vqmrxnf", - "id": "fi_xn647tpmdq8fu8", - "is_group": null, - "logical_op": "and", - "order": 1, - "project_id": "p_xm3thidrblw4n7", - "updated_at": "2023-03-02 18:18:05", - "value": "foo" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - ], - "title": "Filter List Model", - "type": "object", - "x-examples": { - "example-1": { - "bases": { - "list": [ - { - "alias": "string", - "database": "string", - "host": "string", - "id": "string", - "params": "string", - "password": "string", - "port": 0, - "project_id": "string", - "ssl": "string", - "type": "string", - "url": "string", - "username": "string" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "pageSize": 0, - "sort": "string", - "totalRows": 0 - } - } - } - }, - "properties": { - "list": { - "type": "array", - "x-stoplight": { - "id": "22sgv37ve9kxo" - }, - "description": "List of filter objects", - "items": { - "$ref": "#/components/schemas/Filter", - "x-stoplight": { - "id": "ttw5rxhy83k8p" - } - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated", - "x-stoplight": { - "id": "7cyrb1770mrzz" - } - } - }, - "required": ["list", "pageInfo"], - "x-stoplight": { - "id": "mfxg43iomcoue" - } - }, - "FilterLogList": { - "description": "Model for Filter Log List", - "x-stoplight": { - "id": "0voe9zdizy5qd" - }, - "examples": [ - { - "list": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "comparison_op": "eq", - "comparison_sub_op": null, - "created_at": "2023-03-02 18:18:05", - "fk_column_id": "cl_d7ah9n2qfupgys", - "fk_hook_id": null, - "fk_parent_id": null, - "fk_view_id": "vw_b739e29vqmrxnf", - "id": "fi_xn647tpmdq8fu8", - "is_group": null, - "logical_op": "and", - "order": 1, - "project_id": "p_xm3thidrblw4n7", - "updated_at": "2023-03-02 18:18:05", - "value": "foo" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - ], - "title": "Filter Log List Model", - "type": "object", - "x-examples": { - "example-1": { - "bases": { - "list": [ - { - "alias": "string", - "database": "string", - "host": "string", - "id": "string", - "params": "string", - "password": "string", - "port": 0, - "project_id": "string", - "ssl": "string", - "type": "string", - "url": "string", - "username": "string" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "pageSize": 0, - "sort": "string", - "totalRows": 0 - } - } - } - }, - "properties": { - "list": { - "type": "array", - "x-stoplight": { - "id": "22sgv37ve9kxo" - }, - "description": "List of filter objects", - "items": { - "$ref": "#/components/schemas/Filter", - "x-stoplight": { - "id": "ttw5rxhy83k8p" - } - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated", - "x-stoplight": { - "id": "7cyrb1770mrzz" - } - } - }, - "required": ["list", "pageInfo"] - }, - "FilterReq": { - "description": "Model for Filter Request", - "examples": [ - { - "comparison_op": "eq", - "comparison_sub_op": null, - "fk_column_id": "cl_d7ah9n2qfupgys", - "is_group": false, - "logical_op": "and", - "value": "foo" - } - ], - "title": "Filter Request Model", - "type": "object", - "x-stoplight": { - "id": "pugjn1hobswqf" - }, - "properties": { - "comparison_op": { - "description": "Comparison Operator", - "enum": [ - "allof", - "anyof", - "blank", - "btw", - "checked", - "empty", - "eq", - "ge", - "gt", - "gte", - "in", - "is", - "isWithin", - "isnot", - "le", - "like", - "lt", - "lte", - "nallof", - "nanyof", - "nbtw", - "neq", - "nlike", - "not", - "notblank", - "notchecked", - "notempty", - "notnull", - "null" - ], - "type": "string" - }, - "comparison_sub_op": { - "anyOf": [ - { - "enum": [ - "daysAgo", - "daysFromNow", - "exactDate", - "nextMonth", - "nextNumberOfDays", - "nextWeek", - "nextYear", - "oneMonthAgo", - "oneMonthFromNow", - "oneWeekAgo", - "oneWeekFromNow", - "pastMonth", - "pastNumberOfDays", - "pastWeek", - "pastYear", - "today", - "tomorrow", - "yesterday" - ], - "type": "string" - }, - { - "type": "null" - } - ], - "description": "Comparison Sub-Operator" - }, - "fk_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Column" - }, - "fk_parent_id": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Belong to which filter ID" - }, - "is_group": { - "$ref": "#/components/schemas/Bool", - "description": "Is this filter grouped?" - }, - "logical_op": { - "description": "Logical Operator", - "enum": ["and", "not", "or"], - "type": "string" - }, - "value": { - "description": "The filter value. Can be NULL for some operators." - } - }, - "readOnly": true - }, - "Form": { - "description": "Model for Form", - "examples": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "banner_image_url": null, - "columns": [ - { - "id": "fvc_ugj9zo5bzocxtl", - "base_id": "ds_g4ccx6e77h1dmi", - "project_id": "p_xm3thidrblw4n7", - "fk_view_id": "vw_kdf5cr7qmhksek", - "fk_column_id": "cl_phvuuwjrzcdo0g", - "uuid": null, - "label": null, - "help": null, - "description": null, - "required": null, - "show": 0, - "order": 1, - "created_at": "2023-03-04 16:40:47", - "updated_at": "2023-03-04 16:40:47", - "meta": {} - } - ], - "email": "user@example.com", - "fk_model_id": "md_rsu68aqjsbyqtl", - "heading": "My Form", - "lock_type": "collaborative", - "logo_url": null, - "meta": null, - "redirect_after_secs": null, - "redirect_url": null, - "show_blank_form": 0, - "subheading": "My Form Subheading", - "submit_another_form": 0, - "success_msg": "Thank you for the submission.", - "title": "Form View 1" - } - ], - "title": "Form Model", - "type": "object", - "properties": { - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID", - "x-stoplight": { - "id": "z6wjvs00d3qfk" - } - }, - "banner_image_url": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Banner Image URL. Not in use currently." - }, - "columns": { - "type": "array", - "description": "Form Columns", - "items": { - "$ref": "#/components/schemas/FormColumn" - } - }, - "email": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Email to sned after form is submitted" - }, - "fk_model_id": { - "type": "string", - "description": "Foreign Key to Model", - "example": "md_rsu68aqjsbyqtl" - }, - "base_id": { - "type": "string", - "description": "Base ID", - "example": "md_rsu68aqjsbyqtl", - "x-stoplight": { - "id": "kfz7tve8nzj6f" - } - }, - "heading": { - "type": "string", - "description": "The heading of the form", - "example": "My Form" - }, - "lock_type": { - "enum": ["collaborative", "locked", "personal"], - "type": "string", - "description": "Lock Type of this view", - "example": "collaborative" - }, - "logo_url": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Logo URL. Not in use currently." - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "description": "Meta Info for this view" - }, - "redirect_after_secs": { - "$ref": "#/components/schemas/StringOrNull", - "description": "The numbers of seconds to redirect after form submission" - }, - "redirect_url": { - "$ref": "#/components/schemas/StringOrNull", - "description": "URL to redirect after submission" - }, - "show_blank_form": { - "$ref": "#/components/schemas/Bool", - "description": "Show `Blank Form` after 5 seconds" - }, - "subheading": { - "type": "string", - "description": "The subheading of the form", - "example": "My Form Subheading" - }, - "submit_another_form": { - "$ref": "#/components/schemas/Bool", - "description": "Show `Submit Another Form` button" - }, - "success_msg": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Custom message after the form is successfully submitted" - }, - "title": { - "type": "string", - "description": "Form View Title", - "example": "Form View 1" - } - }, - "x-stoplight": { - "id": "918aga51qb7w1" - } - }, - "FormUpdateReq": { - "description": "Model for Form Update Request", - "examples": [ - { - "banner_image_url": null, - "email": "user@example.com", - "heading": "My Form", - "logo_url": null, - "meta": null, - "redirect_after_secs": null, - "redirect_url": null, - "show_blank_form": 0, - "subheading": "My Form Subheading", - "submit_another_form": 0, - "success_msg": "Thank you for the submission." - } - ], - "title": "Form Update Request Model", - "type": "object", - "properties": { - "banner_image_url": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Banner Image URL. Not in use currently." - }, - "email": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Email to sned after form is submitted" - }, - "heading": { - "description": "The heading of the form", - "example": "My Form", - "maxLength": 255, - "type": "string" - }, - "logo_url": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Logo URL. Not in use currently." - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "description": "Meta Info for this view" - }, - "redirect_after_secs": { - "$ref": "#/components/schemas/StringOrNull", - "description": "The numbers of seconds to redirect after form submission" - }, - "redirect_url": { - "$ref": "#/components/schemas/StringOrNull", - "description": "URL to redirect after submission" - }, - "show_blank_form": { - "$ref": "#/components/schemas/Bool", - "description": "Show `Blank Form` after 5 seconds" - }, - "subheading": { - "$ref": "#/components/schemas/StringOrNull", - "description": "The subheading of the form" - }, - "submit_another_form": { - "$ref": "#/components/schemas/Bool", - "description": "Show `Submit Another Form` button" - }, - "success_msg": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Custom message after the form is successfully submitted" - } - }, - "x-stoplight": { - "id": "zn4juts75pksq" - } - }, - "FormColumn": { - "description": "Model for Form Column", - "examples": [ - { - "id": "fvc_1m9b0aub791d4m", - "description": null, - "fk_column_id": "cl_ah9zavkn25ihyd", - "fk_view_id": "vw_6fqln9vdytdv8q", - "help": "This is a help text", - "label": "Form Label", - "meta": null, - "order": 1, - "required": 0, - "show": 0, - "uuid": null - } - ], - "title": "Form Column Model", - "type": "object", - "x-examples": { - "example-1": { - "_cn": "first_name", - "alias": "first_name", - "created_at": "2022-02-15 12:39:04", - "description": "dsdsdsdsd", - "fk_column_id": "cl_yvyhsl9u81tokc", - "fk_view_id": "vw_s1pf4umdnikoyn", - "help": null, - "id": "fvc_8z1i7t8aswkqxx", - "label": "dsdsds", - "order": 1, - "required": false, - "show": 1, - "enable_scanner": true, - "updated_at": "2022-02-15 12:39:16", - "uuid": null - } - }, - "properties": { - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "description": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Form Column Description (Not in use)" - }, - "fk_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Column" - }, - "fk_view_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to View" - }, - "help": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Form Column Help Text" - }, - "label": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Form Column Label" - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "description": "Meta Info" - }, - "order": { - "type": "number", - "description": "The order among all the columns in the form", - "example": 1 - }, - "required": { - "$ref": "#/components/schemas/Bool", - "description": "Is this form column required in submission?" - }, - "show": { - "$ref": "#/components/schemas/Bool", - "description": "Is this column shown in Form?" - }, - "enable_scanner": { - "$ref": "#/components/schemas/Bool", - "description": "Indicates whether the 'Fill by scan' button is visible for this column or not.", - "example": true - }, - "uuid": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Form Column UUID (Not in use)" - } - }, - "x-stoplight": { - "id": "gm46pinkspvrz" - } - }, - "FormColumnReq": { - "description": "Model for Form Column Request", - "examples": [ - { - "description": null, - "help": "This is a help text", - "label": "Form Label", - "meta": null, - "order": 1, - "required": 0, - "show": 0 - } - ], - "title": "Form Column Request Model", - "type": "object", - "x-examples": { - "example-1": { - "_cn": "first_name", - "alias": "first_name", - "created_at": "2022-02-15 12:39:04", - "description": "dsdsdsdsd", - "fk_column_id": "cl_yvyhsl9u81tokc", - "fk_view_id": "vw_s1pf4umdnikoyn", - "help": null, - "id": "fvc_8z1i7t8aswkqxx", - "label": "dsdsds", - "order": 1, - "required": false, - "show": 1, - "updated_at": "2022-02-15 12:39:16", - "uuid": null - } - }, - "properties": { - "description": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Form Column Description (Not in use)" - }, - "help": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Form Column Help Text" - }, - "label": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Form Column Label" - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "description": "Meta Info" - }, - "order": { - "type": "number", - "description": "The order among all the columns in the form" - }, - "required": { - "$ref": "#/components/schemas/Bool", - "description": "Is this form column required in submission?" - }, - "show": { - "$ref": "#/components/schemas/Bool", - "description": "Is this column shown in Form?" - } - }, - "x-stoplight": { - "id": "nmffmb1p3wkg9" - } - }, - "Formula": { - "description": "Model for Formula", - "examples": [ - { - "id": "fm_1lo8wqtvvipdns", - "fk_column_id": "cl_h2micb4jdnmsh1", - "formula": "CONCAT(\"FOO\", {{cl_c5knoi4xs4sfpt}})", - "formula_raw": "CONCAT(\"FOO\", {Title})", - "error": "Error Message shows here" - } - ], - "title": "Formula Model", - "type": "object", - "properties": { - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "fk_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Column" - }, - "formula": { - "type": "string", - "description": "Formula with column ID replaced", - "example": "CONCAT(\"FOO\", {{cl_c5knoi4xs4sfpt}})" - }, - "formula_raw": { - "type": "string", - "description": "Original Formula inputted in UI", - "example": "CONCAT(\"FOO\", {Title})" - }, - "error": { - "type": "string", - "description": "Error Message" - } - }, - "x-stoplight": { - "id": "hlu7yokpavxwb" - } - }, - "FormulaColumnReq": { - "description": "Model for Formula Column Request", - "examples": [ - { - "formula": "CONCAT(\"FOO\", {{cl_c5knoi4xs4sfpt}})", - "formula_raw": "CONCAT(\"FOO\", {Title})", - "title": "Formula", - "uidt": "Formula" - } - ], - "title": "Formula Column Request Model", - "type": "object", - "properties": { - "formula": { - "type": "string", - "description": "Formula with column ID replaced" - }, - "formula_raw": { - "type": "string", - "description": "Original Formula inputted in UI" - }, - "title": { - "maxLength": 255, - "minLength": 1, - "type": "string", - "description": "Formula Title" - }, - "uidt": { - "enum": ["Formula"], - "type": "string", - "description": "UI Data Type" - } - }, - "x-stoplight": { - "id": "v26r0c9hlimtv" - } - }, - "Gallery": { - "description": "Model for Gallery", - "examples": [ - { - "alias": "string", - "columns": [ - { - "fk_col_id": "string", - "fk_gallery_id": "string", - "help": "string", - "id": "string", - "label": "string" - } - ], - "cover_image": "string", - "cover_image_idx": 0, - "deleted": true, - "fk_cover_image_col_id": "string", - "fk_model_id": "string", - "fk_view_id": "string", - "lock_type": "collaborative", - "next_enabled": true, - "order": 0, - "prev_enabled": true, - "restrict_number": "string", - "restrict_size": "string", - "restrict_types": "string", - "title": "string" - } - ], - "properties": { - "alias": { - "type": "string" - }, - "columns": { - "items": { - "$ref": "#/components/schemas/GalleryColumn" - }, - "type": "array" - }, - "cover_image": { - "type": "string" - }, - "cover_image_idx": { - "type": "integer" - }, - "deleted": { - "$ref": "#/components/schemas/Bool" - }, - "fk_cover_image_col_id": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Foreign Key to Cover Image Column" - }, - "fk_model_id": { - "type": "string", - "description": "Foreign Key to Model" - }, - "fk_view_id": { - "type": "string", - "description": "Foreign Key to View" - }, - "lock_type": { - "enum": ["collaborative", "locked", "personal"], - "type": "string" - }, - "next_enabled": { - "$ref": "#/components/schemas/Bool" - }, - "order": { - "type": "number", - "description": "Order of Gallery" - }, - "prev_enabled": { - "$ref": "#/components/schemas/Bool" - }, - "restrict_number": { - "type": "string" - }, - "restrict_size": { - "type": "string" - }, - "restrict_types": { - "type": "string" - }, - "title": { - "type": "string" - } - }, - "title": "Gallery Model", - "type": "object", - "x-stoplight": { - "id": "i0h7av37o4eks" - } - }, - "GalleryColumn": { - "description": "Model for Gallery Column", - "examples": [ - { - "fk_col_id": "string", - "fk_gallery_id": "string", - "help": "string", - "id": "string", - "label": "string" - } - ], - "properties": { - "fk_col_id": { - "type": "string" - }, - "fk_gallery_id": { - "type": "string" - }, - "help": { - "type": "string" - }, - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "label": { - "type": "string" - } - }, - "title": "Gallery Column Model", - "type": "object", - "x-stoplight": { - "id": "jdhvl7gb33fqo" - } - }, - "GalleryUpdateReq": { - "description": "Model for Gallery View Update Request", - "x-stoplight": { - "id": "x57k1fq4101e1" - }, - "examples": [ - { - "fk_cover_image_col_id": "cl_ib8l4j1kiu1efx", - "meta": null - } - ], - "title": "Gallery View Update Request Model", - "type": "object", - "properties": { - "fk_cover_image_col_id": { - "$ref": "#/components/schemas/StringOrNull", - "description": "The id of the column that contains the cover image" - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "x-stoplight": { - "id": "zhp6jkrr54wuf" - }, - "description": "Meta Info" - } - } - }, - "GeoLocation": { - "description": "Model for Geo Location", - "examples": [ - { - "latitude": 18.52139, - "longitude": 179.87295 - } - ], - "properties": { - "latitude": { - "description": "The latitude of the location", - "example": 18.52139, - "exclusiveMaximum": 90, - "exclusiveMinimum": -90, - "format": "double", - "type": "number" - }, - "longitude": { - "description": "The longitude of the location", - "example": 179.87295, - "exclusiveMaximum": 180, - "exclusiveMinimum": -180, - "format": "double", - "type": "number" - } - }, - "title": "Geo Location Model", - "type": "object", - "x-stoplight": { - "id": "685e1l91iuxhv" - } - }, - "Grid": { - "description": "Model for Grid", - "examples": [ - { - "project_id": "p_xm3thidrblw4n7", - "base_id": "ds_g4ccx6e77h1dmi", - "fk_view_id": "vw_p2jcatxz4mvcfw", - "row_height": 1, - "meta": null, - "columns": [ - { - "id": "cl_phvuuwjrzcdo0g", - "base_id": "ds_g4ccx6e77h1dmi", - "project_id": "p_xm3thidrblw4n7", - "fk_model_id": "md_rsu68aqjsbyqtl", - "title": "Id", - "column_name": "id", - "uidt": "ID", - "dt": "int", - "np": "10", - "ns": "0", - "clen": null, - "cop": "1", - "pk": 1, - "pv": null, - "rqd": 1, - "un": 1, - "ct": "int unsigned", - "ai": 1, - "unique": 0, - "cdf": null, - "cc": "", - "csn": null, - "dtx": "specificType", - "dtxp": "", - "dtxs": "0", - "au": 0, - "validate": null, - "virtual": null, - "deleted": null, - "system": 0, - "order": 1, - "created_at": "2023-03-02 17:04:06", - "updated_at": "2023-03-02 17:04:06", - "meta": null - } - ] - } - ], - "title": "Grid Model", - "type": "object", - "properties": { - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID", - "x-stoplight": { - "id": "e3ti3fc0ocjyu" - } - }, - "project_id": { - "$ref": "#/components/schemas/Id", - "description": "Project ID", - "x-stoplight": { - "id": "e3ti3fc0ocjyu" - } - }, - "base_id": { - "$ref": "#/components/schemas/Id", - "description": "Base ID", - "x-stoplight": { - "id": "m8v3iyf1tidy9" - } - }, - "fk_view_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to View", - "x-stoplight": { - "id": "m8v3iyf1tidy9" - } - }, - "row_height": { - "type": "number", - "example": 1, - "description": "Row Height" - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "x-stoplight": { - "id": "n8cud3jyqw5yv" - }, - "description": "Meta info for Grid Model" - }, - "columns": { - "type": "array", - "x-stoplight": { - "id": "22y0gipx2jdf8" - }, - "description": "Grid View Columns", - "items": { - "$ref": "#/components/schemas/GridColumn", - "x-stoplight": { - "id": "nmzp6w3o6b24u" - } - } - } - }, - "x-stoplight": { - "id": "1xswddf91q5pu" - } - }, - "Grid - copy": { - "description": "Model for Grid", - "x-stoplight": { - "id": "xheueli0578g0" - }, - "examples": [ - { - "project_id": "p_xm3thidrblw4n7", - "base_id": "ds_g4ccx6e77h1dmi", - "fk_view_id": "vw_p2jcatxz4mvcfw", - "row_height": 1, - "meta": null, - "columns": [ - { - "id": "cl_phvuuwjrzcdo0g", - "base_id": "ds_g4ccx6e77h1dmi", - "project_id": "p_xm3thidrblw4n7", - "fk_model_id": "md_rsu68aqjsbyqtl", - "title": "Id", - "column_name": "id", - "uidt": "ID", - "dt": "int", - "np": "10", - "ns": "0", - "clen": null, - "cop": "1", - "pk": 1, - "pv": null, - "rqd": 1, - "un": 1, - "ct": "int unsigned", - "ai": 1, - "unique": 0, - "cdf": null, - "cc": "", - "csn": null, - "dtx": "specificType", - "dtxp": "", - "dtxs": "0", - "au": 0, - "validate": null, - "virtual": null, - "deleted": null, - "system": 0, - "order": 1, - "created_at": "2023-03-02 17:04:06", - "updated_at": "2023-03-02 17:04:06", - "meta": null - } - ] - } - ], - "title": "Grid Model", - "type": "object", - "properties": { - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID", - "x-stoplight": { - "id": "e3ti3fc0ocjyu" - } - }, - "project_id": { - "$ref": "#/components/schemas/Id", - "description": "Project ID", - "x-stoplight": { - "id": "e3ti3fc0ocjyu" - } - }, - "base_id": { - "$ref": "#/components/schemas/Id", - "description": "Base ID", - "x-stoplight": { - "id": "m8v3iyf1tidy9" - } - }, - "fk_view_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to View", - "x-stoplight": { - "id": "m8v3iyf1tidy9" - } - }, - "row_height": { - "type": "number", - "example": 1, - "description": "Row Height" - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "x-stoplight": { - "id": "n8cud3jyqw5yv" - }, - "description": "Meta info for Grid Model" - }, - "columns": { - "type": "array", - "x-stoplight": { - "id": "22y0gipx2jdf8" - }, - "description": "Grid View Columns", - "items": { - "$ref": "#/components/schemas/GridColumn", - "x-stoplight": { - "id": "nmzp6w3o6b24u" - } - } - } - } - }, - "GridColumn": { - "description": "Model for Grid Column", - "examples": [ - { - "id": "nc_c8jz4kxe6xvh11", - "fk_view_id": "vw_p2jcatxz4mvcfw", - "fk_column_id": "cl_c5knoi4xs4sfpt", - "project_id": "p_xm3thidrblw4n7", - "base_id": "ds_g4ccx6e77h1dmi", - "show": 0, - "order": 1, - "width": "200px", - "help": null - } - ], - "title": "Grid Column Model", - "type": "object", - "properties": { - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID", - "x-stoplight": { - "id": "jc14yojp52rqj" - } - }, - "fk_view_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to View", - "x-stoplight": { - "id": "vl18dbt5c2r8r" - } - }, - "fk_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Column", - "x-stoplight": { - "id": "2drg88fmodf3v" - } - }, - "project_id": { - "$ref": "#/components/schemas/Id", - "description": "Project ID", - "x-stoplight": { - "id": "2drg88fmodf3v" - } - }, - "base_id": { - "$ref": "#/components/schemas/Id", - "description": "Base ID", - "x-stoplight": { - "id": "2drg88fmodf3v" - } - }, - "show": { - "$ref": "#/components/schemas/Bool", - "x-stoplight": { - "id": "d47eer13oa8yr" - } - }, - "order": { - "type": "number", - "x-stoplight": { - "id": "d47eer13oa8yr" - }, - "example": 1, - "description": "Grid Column Order" - }, - "width": { - "type": "string", - "description": "Column Width", - "example": "200px" - }, - "help": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Column Help Text", - "x-stoplight": { - "id": "azwh6zn37qzkc" - } - } - }, - "x-stoplight": { - "id": "g06nri6t6h6ke" - } - }, - "GridColumnReq": { - "description": "Model for Grid Column Request", - "examples": [ - { - "fk_column_id": "cl_c5knoi4xs4sfpt", - "label": "My Column", - "width": "200px" - } - ], - "properties": { - "fk_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Column" - }, - "help": { - "maxLength": 255, - "type": "string" - }, - "label": { - "description": "The label of the column", - "example": "My Column", - "maxLength": 255, - "type": "string" - }, - "width": { - "description": "The width of the column", - "example": "200px", - "maxLength": 255, - "pattern": "^[0-9]+(px|%)$", - "type": "string" - } - }, - "title": "Grid Column Request Model", - "type": "object", - "x-stoplight": { - "id": "8v9cxve0332zg" - } - }, - "GridUpdateReq": { - "description": "Model for Grid View Update", - "x-stoplight": { - "id": "g10t5gray4bk5" - }, - "examples": [ - { - "row_height": "1", - "meta": null - } - ], - "title": "Grid View Update Model", - "type": "object", - "properties": { - "row_height": { - "type": "number", - "x-stoplight": { - "id": "m5976ax1q13cr" - }, - "description": "Row Height", - "example": 1 - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "x-stoplight": { - "id": "dugbkhe9iupqu" - }, - "description": "Meta Info for grid view" - } - } - }, - "Hook": { - "description": "Model for Hook", - "examples": [ - { - "active": 0, - "async": 0, - "description": "This is my hook description", - "env": "all", - "event": "after", - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "string", - "notification": "{\"type\":\"URL\",\"payload\":{\"method\":\"POST\",\"body\":\"{{ json data }}\",\"headers\":[{}],\"parameters\":[{}],\"auth\":\"\",\"path\":\"http://example.com\"}}", - "null": null, - "operation": "insert", - "retries": 10, - "retry_interval": 60000, - "timeout": 60000, - "title": "My Webhook" - } - ], - "title": "Hook Model", - "type": "object", - "x-stoplight": { - "id": "32blg2oqo6g7p" - }, - "properties": { - "active": { - "$ref": "#/components/schemas/Bool", - "description": "Is the hook active?" - }, - "async": { - "$ref": "#/components/schemas/Bool", - "description": "Is the hook aysnc?" - }, - "description": { - "type": "string", - "description": "Hook Description", - "example": "This is my hook description" - }, - "env": { - "type": "string", - "example": "all", - "description": "Environment for the hook" - }, - "event": { - "enum": ["after", "before"], - "type": "string", - "description": "Event Type for the operation", - "example": "after" - }, - "fk_model_id": { - "type": "string", - "description": "Foreign Key to Model", - "example": "md_rsu68aqjsbyqtl" - }, - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "notification": { - "description": "Hook Notification including info such as type, payload, method, body, and etc", - "type": ["object", "string"] - }, - "operation": { - "enum": [ - "insert", - "update", - "delete", - "bulkInsert", - "bulkUpdate", - "bulkDelete" - ], - "type": "string", - "description": "Hook Operation", - "example": "insert" - }, - "retries": { - "type": "number", - "description": "Retry Count", - "example": 10 - }, - "retry_interval": { - "type": "number", - "description": "Retry Interval", - "example": 60000 - }, - "timeout": { - "type": "number", - "example": 60000, - "description": "Timeout" - }, - "title": { - "type": "string", - "description": "Hook Title", - "example": "My Webhook" - }, - "type": { - "type": "string", - "description": "Hook Type" - }, - "version": { - "type": "string", - "x-stoplight": { - "id": "socewqvadj91n" - }, - "example": "v2", - "description": "Hook Version", - "enum": ["v1", "v2"] - } - } - }, - "HookReq": { - "description": "Model for Hook", - "x-stoplight": { - "id": "85vr8fx3oea31" - }, - "examples": [ - { - "active": 0, - "async": 0, - "description": "This is my hook description", - "env": "all", - "event": "after", - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "string", - "notification": "{\"type\":\"URL\",\"payload\":{\"method\":\"POST\",\"body\":\"{{ json data }}\",\"headers\":[{}],\"parameters\":[{}],\"auth\":\"\",\"path\":\"http://example.com\"}}", - "null": null, - "operation": "insert", - "retries": 10, - "retry_interval": 60000, - "timeout": 60000, - "title": "My Webhook", - "condition": false - } - ], - "title": "Hook Request Model", - "type": "object", - "properties": { - "active": { - "$ref": "#/components/schemas/Bool", - "description": "Is the hook active?" - }, - "async": { - "$ref": "#/components/schemas/Bool", - "description": "Is the hook aysnc?" - }, - "description": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Hook Description" - }, - "env": { - "type": "string", - "example": "all", - "description": "Environment for the hook" - }, - "event": { - "enum": ["after", "before"], - "type": "string", - "description": "Event Type for the operation", - "example": "after" - }, - "fk_model_id": { - "type": "string", - "description": "Foreign Key to Model", - "example": "md_rsu68aqjsbyqtl" - }, - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "notification": { - "description": "Hook Notification including info such as type, payload, method, body, and etc", - "type": ["object", "string"] - }, - "operation": { - "enum": [ - "insert", - "update", - "delete", - "bulkInsert", - "bulkUpdate", - "bulkDelete" - ], - "type": "string", - "description": "Hook Operation", - "example": "insert" - }, - "retries": { - "type": "number", - "description": "Retry Count", - "example": 10 - }, - "retry_interval": { - "type": "number", - "description": "Retry Interval", - "example": 60000 - }, - "timeout": { - "type": "number", - "example": 60000, - "description": "Timeout" - }, - "title": { - "type": "string", - "description": "Hook Title", - "example": "My Webhook" - }, - "type": { - "type": ["string", "null"], - "description": "Hook Type" - }, - "condition": { - "$ref": "#/components/schemas/Bool", - "x-stoplight": { - "id": "wwzoum7rrlwun" - }, - "description": "Is this hook assoicated with some filters" - } - }, - "required": ["event", "notification", "operation", "title"] - }, - "HookList": { - "description": "Model for Hook List", - "examples": [ - { - "list": [ - { - "active": 0, - "async": 0, - "description": "This is my hook description", - "env": "all", - "event": "after", - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "string", - "notification": "{\"type\":\"URL\",\"payload\":{\"method\":\"POST\",\"body\":\"{{ json data }}\",\"headers\":[{}],\"parameters\":[{}],\"auth\":\"\",\"path\":\"http://example.com\"}}", - "null": null, - "operation": "insert", - "retries": 10, - "retry_interval": 60000, - "timeout": 60000, - "title": "My Webhook" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - ], - "title": "Hook List Model", - "type": "object", - "x-examples": { - "example-1": { - "bases": { - "list": [ - { - "alias": "string", - "database": "string", - "host": "string", - "id": "string", - "params": "string", - "password": "string", - "port": 0, - "project_id": "string", - "ssl": "string", - "type": "string", - "url": "string", - "username": "string" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "pageSize": 0, - "sort": "string", - "totalRows": 0 - } - } - } - }, - "properties": { - "list": { - "minItems": 1, - "type": "array", - "uniqueItems": true, - "description": "List of hook objects", - "items": { - "$ref": "#/components/schemas/Hook" - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated" - } - }, - "required": ["list", "pageInfo"], - "x-stoplight": { - "id": "n2sbatqu55day" - } - }, - "HookLog": { - "description": "Model for Hook Log", - "examples": [ - { - "base_id": "ds_jxuewivwbxeum2", - "event": "after", - "execution_time": "98", - "fk_hook_id": "hk_035ijv5qdi97y5", - "id": "string", - "notifications": "{\"type\":\"URL\",\"payload\":{\"method\":\"POST\",\"body\":\"{{ json data }}\",\"headers\":[{}],\"parameters\":[{}],\"auth\":\"\",\"path\":\"https://webhook.site/6eb45ce5-b611-4be1-8b96-c2965755662b\"}}", - "operation": "insert", - "payload": "{\"method\":\"POST\",\"body\":\"{{ json data }}\",\"headers\":[{}],\"parameters\":[{}],\"auth\":\"\",\"path\":\"https://webhook.site/6eb45ce5-b611-4be1-8b96-c2965755662b\"}", - "project_id": "p_tbhl1hnycvhe5l", - "response": "{\"status\":200,\"statusText\":\"OK\",\"headers\":{\"server\":\"nginx\",\"content-type\":\"text/plain; charset=UTF-8\",\"transfer-encoding\":\"chunked\",\"connection\":\"close\",\"vary\":\"Accept-Encoding\",\"x-request-id\":\"53844a7d-ede8-4798-adf7-8af441908a72\",\"x-token-id\":\"6eb45ce5-b611-4be1-8b96-c2965755662b\",\"cache-control\":\"no-cache, private\",\"date\":\"Fri, 24 Mar 2023 10:50:10 GMT\"},\"config\":{\"url\":\"https://webhook.site/6eb45ce5-b611-4be1-8b96-c2965755662b\",\"method\":\"post\",\"data\":\"{\\\"type\\\":\\\"records.after.insert\\\",\\\"id\\\":\\\"a77d97dc-a3e4-4719-9b46-45f93e0cc99a\\\",\\\"data\\\":{\\\"table_id\\\":\\\"md_d8v403o74mf5lf\\\",\\\"table_name\\\":\\\"Sheet-2\\\"}}\",\"headers\":{\"Accept\":\"application/json, text/plain, */*\",\"Content-Type\":\"application/x-www-form-urlencoded\",\"User-Agent\":\"axios/0.21.4\",\"Content-Length\":138},\"params\":{}}}", - "test_call": 0, - "triggered_by": "w@nocodb.com", - "type": "URL" - } - ], - "title": "Hook Log Model", - "type": "object", - "x-stoplight": { - "id": "ni303795b18y5" - }, - "properties": { - "base_id": { - "type": "string", - "description": "Unique Base ID", - "example": "ds_jxuewivwbxeum2" - }, - "conditions": { - "type": "string", - "description": "Hook Conditions" - }, - "error": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Error" - }, - "error_code": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Error Code" - }, - "error_message": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Error Message" - }, - "event": { - "type": "string", - "description": "Hook Event", - "example": "after", - "enum": ["after", "before"] - }, - "execution_time": { - "type": "string", - "description": "Execution Time in milliseconds", - "example": "98" - }, - "fk_hook_id": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Foreign Key to Hook" - }, - "id": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Unique ID" - }, - "notifications": { - "type": "string", - "description": "Hook Notification" - }, - "operation": { - "type": "string", - "description": "Hook Operation", - "enum": [ - "insert", - "update", - "delete", - "bulkInsert", - "bulkUpdate", - "bulkDelete" - ], - "example": "insert" - }, - "payload": { - "type": "string", - "description": "Hook Payload", - "example": "{\"method\":\"POST\",\"body\":\"{{ json data }}\",\"headers\":[{}],\"parameters\":[{}],\"auth\":\"\",\"path\":\"https://webhook.site/6eb45ce5-b611-4be1-8b96-c2965755662b\"}" - }, - "project_id": { - "type": "string", - "description": "Project ID", - "example": "p_tbhl1hnycvhe5l" - }, - "response": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Hook Response" - }, - "test_call": { - "$ref": "#/components/schemas/Bool", - "description": "Is this testing hook call?" - }, - "triggered_by": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Who triggered the hook?" - }, - "type": { - "type": "string", - "example": "URL", - "description": "Hook Type" - } - } - }, - "HookLogList": { - "description": "Model for Hook Log List", - "x-stoplight": { - "id": "tfv7y629w2ap2" - }, - "examples": [], - "title": "Hook Log List Model", - "type": "object", - "x-examples": { - "example-1": { - "bases": { - "list": [ - { - "alias": "string", - "database": "string", - "host": "string", - "id": "string", - "params": "string", - "password": "string", - "port": 0, - "project_id": "string", - "ssl": "string", - "type": "string", - "url": "string", - "username": "string" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "pageSize": 0, - "sort": "string", - "totalRows": 0 - } - } - } - }, - "properties": { - "list": { - "minItems": 1, - "type": "array", - "uniqueItems": true, - "description": "List of hook objects", - "items": { - "$ref": "#/components/schemas/HookLog" - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated" - } - }, - "required": ["list", "pageInfo"] - }, - "HookTestReq": { - "description": "Model for Hook Test Request", - "examples": [ - { - "hook": { - "active": 0, - "async": 0, - "description": "This is my hook description", - "env": "all", - "event": "after", - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "string", - "notification": "{\"type\":\"URL\",\"payload\":{\"method\":\"POST\",\"body\":\"{{ json data }}\",\"headers\":[{}],\"parameters\":[{}],\"auth\":\"\",\"path\":\"http://example.com\"}}", - "null": null, - "operation": "insert", - "retries": 10, - "retry_interval": 60000, - "timeout": 60000, - "title": "My Webhook" - }, - "payload": { - "data": { - "Id": 1, - "Title": "Sample Text", - "CreatedAt": "2023-03-03T10:03:06.484Z", - "UpdatedAt": "2023-03-03T10:03:06.484Z", - "attachment": [ - { - "url": "https://nocodb.com/dummy.png", - "title": "image.png", - "mimetype": "image/png", - "size": 0 - } - ], - "f": "Sample Output" - } - } - } - ], - "title": "Hook Test Request Model", - "type": "object", - "properties": { - "hook": { - "$ref": "#/components/schemas/HookReq" - }, - "payload": { - "description": "Payload to be sent" - } - }, - "required": ["hook", "payload"], - "x-stoplight": { - "id": "w64q11jiv01np" - } - }, - "Id": { - "description": "Model for ID", - "examples": ["string"], - "maxLength": 20, - "minLength": 0, - "title": "ID Model", - "type": "string", - "x-stoplight": { - "id": "obj8r7jhyfoqg" - } - }, - "Kanban": { - "description": "Model for Kanban", - "examples": [ - { - "id": "vw_wqs4zheuo5lgdy", - "fk_grp_col_id": "cl_3704cxcbqt7sj7", - "fk_view_id": "vw_wqs4zheuo5lgdy", - "fk_cover_image_col_id": null, - "columns": [ - { - "id": "kvc_2skkg5mi1eb37f", - "fk_column_id": "cl_hzos4ghyncqi4k", - "fk_view_id": "vw_wqs4zheuo5lgdy", - "base_id": "ds_hd4ojj0xpquaam", - "project_id": "p_kzfl5lb0t3tcok", - "title": "string", - "show": 0, - "order": "1" - } - ], - "meta": null, - "title": "My Kanban" - } - ], - "title": "Kanban Model", - "type": "object", - "properties": { - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "fk_grp_col_id": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Grouping Field Column ID" - }, - "fk_view_id": { - "$ref": "#/components/schemas/Id", - "x-stoplight": { - "id": "1kgw1w06b97nl" - }, - "description": "View ID" - }, - "fk_cover_image_col_id": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Cover Image Column ID" - }, - "columns": { - "type": "array", - "description": "Kanban Columns", - "items": { - "$ref": "#/components/schemas/KanbanColumn" - } - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "description": "Meta Info for Kanban" - }, - "title": { - "type": "string", - "description": "Kanban Title", - "example": "My Kanban" - } - }, - "x-stoplight": { - "id": "sfbbvgbcv7je6" - } - }, - "KanbanColumn": { - "description": "Model for Kanban Column", - "examples": [ - { - "id": "kvc_2skkg5mi1eb37f", - "fk_column_id": "cl_hzos4ghyncqi4k", - "fk_view_id": "vw_wqs4zheuo5lgdy", - "base_id": "ds_hd4ojj0xpquaam", - "project_id": "p_kzfl5lb0t3tcok", - "title": "string", - "show": 0, - "order": "1" - } - ], - "title": "Kanban Column Model", - "type": "object", - "properties": { - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "fk_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Column" - }, - "fk_view_id": { - "$ref": "#/components/schemas/Id", - "x-stoplight": { - "id": "t1fy4zy561ih8" - }, - "description": "Foreign Key to View" - }, - "base_id": { - "$ref": "#/components/schemas/Id", - "x-stoplight": { - "id": "uqq8xmyz97t1u" - }, - "description": "Baes ID\n" - }, - "project_id": { - "$ref": "#/components/schemas/Id", - "x-stoplight": { - "id": "uqq8xmyz97t1u" - }, - "description": "Project ID" - }, - "title": { - "x-stoplight": { - "id": "uqq8xmyz97t1u" - }, - "description": "Project ID", - "type": "string" - }, - "show": { - "$ref": "#/components/schemas/Bool", - "x-stoplight": { - "id": "uqq8xmyz97t1u" - }, - "description": "Is this column shown?" - }, - "order": { - "type": "number", - "x-stoplight": { - "id": "pbnchzgci5dwa" - }, - "example": 1, - "description": "Column Order" - } - }, - "x-stoplight": { - "id": "epfedw9ccxgxe" - } - }, - "KanbanUpdateReq": { - "description": "Model for Kanban Update Request", - "examples": [ - { - "fk_grp_col_id": "cl_g0a89q9xdry3lu", - "fk_cover_image_col_id": "cl_ib8l4j1kiu1efx", - "meta": { - "cl_g0a89q9xdry3lu": [ - { - "id": "uncategorized", - "title": null, - "order": 0, - "color": "#c2f5e8", - "collapsed": false - }, - { - "id": "sl_ihyva6jx6dg0fc", - "fk_column_id": "cl_g0a89q9xdry3lu", - "title": "a", - "color": "#cfdffe", - "order": 1, - "collapsed": false - }, - { - "id": "sl_gqdm5v6t8aetoa", - "fk_column_id": "cl_g0a89q9xdry3lu", - "title": "b", - "color": "#d0f1fd", - "order": 2, - "collapsed": false - }, - { - "id": "sl_eipnl0kn7a9d3c", - "fk_column_id": "cl_g0a89q9xdry3lu", - "title": "cc", - "color": "#c2f5e8", - "order": 3, - "collapsed": false - }, - { - "id": "sl_dei8p2jq0cnlv0", - "fk_column_id": "cl_g0a89q9xdry3lu", - "title": "d", - "color": "#ffdaf6", - "order": 4, - "collapsed": false - } - ] - } - } - ], - "title": "Kanban Update Request Model", - "type": "object", - "properties": { - "fk_grp_col_id": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Foreign Key to Grouping Field Column" - }, - "fk_cover_image_col_id": { - "$ref": "#/components/schemas/StringOrNull", - "x-stoplight": { - "id": "81wn4hzj76wod" - }, - "description": "Foreign Key to Cover Image Column" - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "x-stoplight": { - "id": "stsvdmkli1b0r" - }, - "description": "Meta Info" - } - }, - "x-stoplight": { - "id": "b1jlyk12kfuwx" - } - }, - "LicenseReq": { - "description": "Model for Kanban Request", - "examples": [ - { - "key": "1234567890" - } - ], - "properties": { - "key": { - "description": "The license key", - "example": "1234567890", - "maxLength": 255, - "minLength": 10, - "type": "string" - } - }, - "title": "License Key Request Model", - "type": "object", - "x-stoplight": { - "id": "trgk6qlmgdyfo" - } - }, - "LinkToAnotherColumnReq": { - "description": "Model for LinkToAnotherColumn Request", - "examples": [ - { - "childId": "string", - "parentId": "string", - "title": "string", - "type": "hm", - "uidt": "LinkToAnotherRecord", - "virtual": true - } - ], - "properties": { - "childId": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to chhild column" - }, - "parentId": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to parent column" - }, - "title": { - "maxLength": 255, - "minLength": 1, - "type": "string", - "description": "The title of the virtual column" - }, - "type": { - "enum": ["bt", "hm", "mm"], - "type": "string", - "description": "The type of the relationship" - }, - "uidt": { - "enum": ["LinkToAnotherRecord"], - "type": "string", - "description": "Abstract type of the relationship" - }, - "virtual": { - "$ref": "#/components/schemas/Bool", - "description": "Is this relationship virtual?" - } - }, - "required": ["childId", "parentId", "title", "type", "uidt"], - "title": "LinkToAnotherColumn Request Model", - "type": "object", - "x-stoplight": { - "id": "x59gz5reg12x3" - } - }, - "LinkToAnotherRecord": { - "description": "Model for LinkToAnotherRecord", - "examples": [ - { - "deleted": "string", - "dr": "string", - "fk_child_column_id": "string", - "fk_column_id": "string", - "fk_index_name": "string", - "fk_mm_child_column_id": "string", - "fk_mm_model_id": "string", - "fk_mm_parent_column_id": "string", - "fk_parent_column_id": "string", - "fk_related_model_id": "string", - "id": "string", - "order": "string", - "type": "string", - "ur": "string", - "virtual": true - } - ], - "properties": { - "deleted": { - "type": "string" - }, - "dr": { - "type": "string" - }, - "fk_child_column_id": { - "type": "string" - }, - "fk_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Column" - }, - "fk_index_name": { - "type": "string" - }, - "fk_mm_child_column_id": { - "type": "string" - }, - "fk_mm_model_id": { - "type": "string" - }, - "fk_mm_parent_column_id": { - "type": "string" - }, - "fk_parent_column_id": { - "type": "string" - }, - "fk_related_model_id": { - "type": "string" - }, - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "order": { - "type": "string" - }, - "type": { - "type": "string" - }, - "ur": { - "type": "string" - }, - "virtual": { - "$ref": "#/components/schemas/Bool" - } - }, - "title": "LinkToAnotherRecord Model", - "type": "object", - "x-stoplight": { - "id": "27q0vnr79hxla" - } - }, - "Lookup": { - "description": "Model for Lookup", - "examples": [ - { - "id": "lk_mngsu0e45njbxr", - "fk_column_id": "cl_vdiy9bz7h11kdm", - "fk_relation_column_id": "cl_5jestblzneb649", - "fk_lookup_column_id": "cl_4cm47dtjphgqkv", - "order": 1 - } - ], - "title": "Lookup Model", - "type": "object", - "properties": { - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "fk_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Column" - }, - "fk_lookup_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Lookup Column" - }, - "fk_relation_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Relation Column" - }, - "order": { - "type": "number", - "description": "The order among the list", - "example": 1 - } - }, - "x-stoplight": { - "id": "guyozhka8sx1t" - } - }, - "LookupColumnReq": { - "description": "Model for Lookup Column Request", - "examples": [ - { - "fk_relation_column_id": "cl_5jestblzneb649", - "fk_lookup_column_id": "cl_4cm47dtjphgqkv", - "title": "My Lookup", - "uidt": "Lookup" - } - ], - "title": "Lookup Column Request Model", - "type": "object", - "properties": { - "fk_lookup_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Lookup Column" - }, - "fk_relation_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Relation Column" - }, - "title": { - "maxLength": 255, - "type": "string", - "description": "Lookup Title", - "example": "My Lookup" - }, - "uidt": { - "enum": ["Lookup"], - "type": "string", - "description": "UI DataType" - } - }, - "x-stoplight": { - "id": "hmeckhq2ciwpf" - } - }, - "Map": { - "description": "Model for Map", - "examples": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "columns": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "fk_column_id": "cl_8iw2o4ejzvdyna", - "fk_view_id": "vw_qjt7klod1p9kyv", - "id": "nc_46xcacqn4rc9xf", - "order": 1, - "project_id": "p_xm3thidrblw4n7", - "show": 1 - } - ], - "fk_geo_data_col_id": "cl_8iw2o4ejzvdyna", - "fk_view_id": "vw_qjt7klod1p9kyv", - "meta": {}, - "order": 0, - "project_id": "p_xm3thidrblw4n7", - "show": true, - "title": "My Map" - } - ], - "properties": { - "base_id": { - "description": "The ID of the base that this view belongs to", - "example": "ds_g4ccx6e77h1dmi", - "type": "string" - }, - "columns": { - "description": "Columns in this view", - "items": { - "$ref": "#/components/schemas/MapColumn" - }, - "type": "array" - }, - "fk_geo_data_col_id": { - "description": "Foreign Key to GeoData Column", - "example": "cl_8iw2o4ejzvdyna", - "type": "string" - }, - "fk_view_id": { - "description": "Unique ID for Map", - "example": "vw_qjt7klod1p9kyv", - "type": "string" - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "description": "Meta data for this view" - }, - "order": { - "description": "The order of the map list", - "type": "number" - }, - "project_id": { - "description": "The ID of the project that this view belongs to", - "example": "p_xm3thidrblw4n7", - "type": "string" - }, - "show": { - "description": "To show this Map or not", - "type": "boolean" - }, - "title": { - "description": "Title of Map View", - "example": "My Map", - "type": "string" - } - }, - "title": "Map Model", - "type": "object", - "x-stoplight": { - "id": "hd60sf3k0bs3w" - } - }, - "MapUpdateReq": { - "description": "Model for Map", - "x-stoplight": { - "id": "3hceyh9ukp5ln" - }, - "examples": [ - { - "fk_geo_data_col_id": "cl_8iw2o4ejzvdyna", - "meta": null - } - ], - "title": "Map View Update Request Model", - "type": "object", - "properties": { - "fk_geo_data_col_id": { - "description": "Foreign Key to GeoData Column", - "example": "cl_8iw2o4ejzvdyna", - "type": "string" - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "description": "Meta data for this view" - } - } - }, - "MapColumn": { - "description": "Model for Map Column", - "examples": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "fk_column_id": "cl_8iw2o4ejzvdyna", - "fk_view_id": "vw_qjt7klod1p9kyv", - "id": "nc_46xcacqn4rc9xf", - "order": 1, - "project_id": "p_xm3thidrblw4n7", - "show": 1 - } - ], - "properties": { - "base_id": { - "description": "The ID of the base that this map column belongs to", - "example": "ds_g4ccx6e77h1dmi", - "type": "string" - }, - "fk_column_id": { - "description": "Foreign Key to Column", - "example": "cl_8iw2o4ejzvdyna", - "type": "string" - }, - "fk_view_id": { - "description": "Foreign Key to View", - "example": "vw_qjt7klod1p9kyv", - "type": "string" - }, - "id": { - "description": "Unique ID of Map Column", - "example": "nc_46xcacqn4rc9xf", - "type": "string" - }, - "order": { - "description": "the order in the list of map columns", - "example": 1, - "type": "number" - }, - "project_id": { - "description": "The ID of the project that this map column belongs to", - "example": "p_xm3thidrblw4n7", - "type": "string" - }, - "show": { - "description": "Whether to show this column or not", - "example": 1, - "type": "number" - } - }, - "title": "Map Column Model", - "type": "object", - "x-stoplight": { - "id": "bvk0acuepoqw1" - } - }, - "Meta": { - "description": "Model for Meta", - "examples": [{}], - "oneOf": [ - { - "type": "null" - }, - { - "type": "object" - }, - { - "type": "string" - } - ], - "title": "Meta Model", - "x-stoplight": { - "id": "2ohjoms6hjcym" - } - }, - "ModelRoleVisibility": { - "description": "Model for ModelRoleVisibility", - "examples": [ - { - "base_id": "string", - "disabled": true, - "fk_model_id": "string", - "fk_view_id": "string", - "id": "string", - "project_id": "string", - "role": "string" - } - ], - "properties": { - "base_id": { - "type": "string" - }, - "disabled": { - "$ref": "#/components/schemas/Bool" - }, - "fk_model_id": { - "type": "string" - }, - "fk_view_id": { - "type": "string" - }, - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "project_id": { - "type": "string" - }, - "role": { - "type": "string" - } - }, - "title": "ModelRoleVisibility Model", - "type": "object", - "x-stoplight": { - "id": "68m1dblcswem2" - } - }, - "NormalColumnRequest": { - "description": "Model for Normal Column Request", - "examples": [ - { - "ai": true, - "au": true, - "cc": "string", - "cdf": "string", - "column_name": "string", - "csn": "string", - "dt": "string", - "dtx": "string", - "dtxp": 0, - "dtxs": 0, - "np": 0, - "ns": 0, - "pk": true, - "pv": true, - "rqd": true, - "title": "string", - "uidt": "ID", - "un": true, - "unique": true - } - ], - "properties": { - "ai": { - "$ref": "#/components/schemas/Bool", - "description": "Is this column auto-incremented?" - }, - "au": { - "$ref": "#/components/schemas/Bool", - "description": "Is this column auto-updated datetime field?" - }, - "cc": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Column Comment" - }, - "cdf": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Column Default Value" - }, - "column_name": { - "maxLength": 255, - "minLength": 1, - "type": "string", - "description": "Column Name" - }, - "csn": { - "$ref": "#/components/schemas/StringOrNull" - }, - "dt": { - "type": "string", - "description": "Data Type" - }, - "dtx": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Data Type Extra" - }, - "dtxp": { - "oneOf": [ - { - "$ref": "#/components/schemas/StringOrNull" - }, - { - "type": "number" - } - ], - "description": "Data Type Extra Precision" - }, - "dtxs": { - "oneOf": [ - { - "$ref": "#/components/schemas/StringOrNull" - }, - { - "type": "number" - } - ], - "description": "Data Type Extra Scale" - }, - "np": { - "oneOf": [ - { - "$ref": "#/components/schemas/StringOrNull" - }, - { - "type": "integer" - } - ], - "description": "Numeric Precision" - }, - "ns": { - "oneOf": [ - { - "$ref": "#/components/schemas/StringOrNull" - }, - { - "type": "integer" - } - ], - "description": "Numeric Scale" - }, - "pk": { - "$ref": "#/components/schemas/Bool", - "description": "Is this column a primary key?" - }, - "pv": { - "$ref": "#/components/schemas/Bool", - "description": "Is this column a primary value?" - }, - "rqd": { - "$ref": "#/components/schemas/Bool", - "description": "Is this column required?" - }, - "title": { - "maxLength": 255, - "type": "string", - "description": "Column Title" - }, - "uidt": { - "enum": [ - "Attachment", - "AutoNumber", - "Barcode", - "Button", - "Checkbox", - "Collaborator", - "Count", - "CreateTime", - "Currency", - "Date", - "DateTime", - "Decimal", - "Duration", - "Email", - "Formula", - "ForeignKey", - "GeoData", - "Geometry", - "ID", - "JSON", - "LastModifiedTime", - "LongText", - "LinkToAnotherRecord", - "Lookup", - "MultiSelect", - "Number", - "Percent", - "PhoneNumber", - "Rating", - "Rollup", - "SingleLineText", - "SingleSelect", - "SpecificDBType", - "Time", - "URL", - "Year", - "QrCode" - ], - "type": "string", - "description": "UI Data Type" - }, - "un": { - "$ref": "#/components/schemas/Bool", - "description": "Is this column unique?" - }, - "unique": { - "$ref": "#/components/schemas/Bool", - "description": "Is this column unique?" - } - }, - "title": "Normal Column Request Model", - "type": "object", - "required": ["column_name"], - "x-stoplight": { - "id": "b67hswwa49t9u" - } - }, - "OrgUserReq": { - "description": "Model for Organisation User Update Request", - "examples": [ - { - "email": "user@example.com", - "roles": "org-level-creator" - } - ], - "properties": { - "email": { - "format": "email", - "type": "string" - }, - "roles": { - "enum": ["org-level-creator", "org-level-viewer"], - "type": "string", - "description": "Roles for the project user" - } - }, - "title": "Organisation User Request Model", - "type": "object", - "x-stoplight": { - "id": "hs5aforkqjbkb" - } - }, - "Paginated": { - "description": "Model for Paginated", - "examples": [ - { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - ], - "properties": { - "isFirstPage": { - "description": "Is the current page the first page", - "type": "boolean" - }, - "isLastPage": { - "description": "Is the current page the last page", - "type": "boolean" - }, - "page": { - "description": "The current page", - "example": 1, - "type": "number" - }, - "pageSize": { - "description": "The number of pages", - "example": 10, - "type": "number" - }, - "totalRows": { - "description": "The number of rows in the given result", - "example": 1, - "type": "number" - } - }, - "title": "Paginated Model", - "type": "object", - "x-stoplight": { - "id": "ny0v2losvmitz" - } - }, - "Password": { - "description": "Model for Password", - "example": "password123456789", - "examples": ["password123456789"], - "minLength": 8, - "title": "Password Model", - "type": "string", - "x-stoplight": { - "id": "c6iocwuo2j8z8" - } - }, - "PasswordChangeReq": { - "description": "Model for Password Change Request", - "examples": [ - { - "currentPassword": "currentpassword", - "newPassword": "newpassword" - } - ], - "properties": { - "currentPassword": { - "type": "string" - }, - "newPassword": { - "minLength": 8, - "type": "string" - } - }, - "required": ["currentPassword", "newPassword"], - "title": "Password Change Request Model", - "type": "object", - "x-stoplight": { - "id": "99dogahvh0gla" - } - }, - "PasswordForgotReq": { - "description": "Model for Password Forgot Request", - "examples": [ - { - "email": "user@example.com" - } - ], - "properties": { - "email": { - "description": "Email address of the user", - "format": "email", - "type": "string" - } - }, - "required": ["email"], - "title": "Password Forgot Request Model", - "type": "object", - "x-stoplight": { - "id": "1kkft7m54ax45" - } - }, - "PasswordResetReq": { - "description": "Model for Password Reset Request", - "examples": [ - { - "password": "newpassword" - } - ], - "properties": { - "password": { - "description": "New password", - "example": "newpassword", - "minLength": 8, - "type": "string" - } - }, - "required": ["password"], - "title": "Password Reset Request Model", - "type": "object", - "x-stoplight": { - "id": "i3gzz403zjwh8" - } - }, - "Plugin": { - "description": "Model for Plugin", - "examples": [ - { - "id": "nc_tljibbzcyjrhcc", - "title": "S3", - "description": "Amazon Simple Storage Service (Amazon S3) is an object storage service that offers industry-leading scalability, data availability, security, and performance.", - "active": true, - "rating": null, - "version": "0.0.1", - "docs": null, - "status": "install", - "status_details": null, - "logo": "plugins/s3.png", - "icon": null, - "tags": "Storage", - "category": "Storage", - "input_schema": "{\"title\":\"Configure Amazon S3\",\"items\":[{\"key\":\"bucket\",\"label\":\"Bucket Name\",\"placeholder\":\"Bucket Name\",\"type\":\"SingleLineText\",\"required\":true},{\"key\":\"region\",\"label\":\"Region\",\"placeholder\":\"Region\",\"type\":\"SingleLineText\",\"required\":true},{\"key\":\"access_key\",\"label\":\"Access Key\",\"placeholder\":\"Access Key\",\"type\":\"SingleLineText\",\"required\":true},{\"key\":\"access_secret\",\"label\":\"Access Secret\",\"placeholder\":\"Access Secret\",\"type\":\"Password\",\"required\":true}],\"actions\":[{\"label\":\"Test\",\"placeholder\":\"Test\",\"key\":\"test\",\"actionType\":\"TEST\",\"type\":\"Button\"},{\"label\":\"Save\",\"placeholder\":\"Save\",\"key\":\"save\",\"actionType\":\"SUBMIT\",\"type\":\"Button\"}],\"msgOnInstall\":\"Successfully installed and attachment will be stored in AWS S3\",\"msgOnUninstall\":\"\"}", - "input": "{\"bucket\":\"my-bucket\",\"region\":\"us-west-004\",\"access_key\":\"redacted\",\"access_secret\":\"redacted\"}", - "creator": null, - "creator_website": null, - "price": null - } - ], - "title": "Plugin Model", - "type": "object", - "properties": { - "active": { - "$ref": "#/components/schemas/Bool", - "description": "Is plguin active?" - }, - "category": { - "type": "string", - "description": "Plugin Category", - "example": "Storage" - }, - "creator": { - "type": "string", - "description": "Plugin Creator (Not in use)" - }, - "creator_website": { - "type": "string", - "description": "Plugin Creator website (Not in use)" - }, - "description": { - "type": "string", - "description": "Plugin Description", - "example": "Amazon Simple Storage Service (Amazon S3) is an object storage service that offers industry-leading scalability, data availability, security, and performance." - }, - "docs": { - "type": "string", - "description": "Documentation of plugin (Not in use)" - }, - "icon": { - "type": "string", - "description": "Plugin Icon (Not in use)" - }, - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "input": { - "oneOf": [ - { - "$ref": "#/components/schemas/StringOrNull" - }, - { - "type": "integer" - } - ], - "description": "Plugin Input" - }, - "input_schema": { - "type": "string", - "description": "Plugin Input Schema\n" - }, - "logo": { - "type": "string", - "description": "Plugin logo", - "example": "plugins/s3.png" - }, - "price": { - "type": "string", - "description": "Plugin Price (Not in use)" - }, - "rating": { - "type": "number", - "description": "Plugin Rating (Not in use)" - }, - "status": { - "type": "string", - "description": "Plugin Status", - "example": "install" - }, - "status_details": { - "type": "string", - "description": "Not in use" - }, - "tags": { - "type": "string", - "description": "Plugin tags", - "example": "Storage" - }, - "title": { - "type": "string", - "description": "Plugin Title" - }, - "version": { - "type": "string", - "description": "Plugin Version", - "example": "0.0.1" - } - }, - "x-stoplight": { - "id": "uux5n95kbh2r5" - } - }, - "PluginReq": { - "description": "Model for Plugin Request", - "examples": [ - { - "active": 0, - "input": "{\"bucket\":\"my-bucket\",\"region\":\"us-west-004\",\"access_key\":\"redacted\",\"access_secret\":\"redacted\"}" - } - ], - "title": "Plugin Reqeust", - "type": "object", - "properties": { - "active": { - "$ref": "#/components/schemas/Bool", - "description": "Is Plugin Active?" - }, - "input": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Plugin Input" - } - }, - "x-stoplight": { - "id": "pci8zg4wgn3bx" - } - }, - "PluginTestReq": { - "description": "Model for Plugin Test Request", - "examples": [ - { - "title": "Plugin Foo", - "input": "{\"bucket\":\"my-bucket\",\"region\":\"us-west-004\",\"access_key\":\"redacted\",\"access_secret\":\"redacted\"}", - "category": "Email" - } - ], - "title": "Plugin Test Request Model", - "type": "object", - "properties": { - "title": { - "maxLength": 45, - "type": "string", - "description": "Plugin Title" - }, - "input": { - "oneOf": [ - { - "type": "string", - "description": "Plugin Input as JSON string" - }, - { - "description": "Plugin Input", - "type": "object" - } - ] - }, - "category": { - "x-stoplight": { - "id": "rg3i3ov9rs6d0" - }, - "type": "string", - "example": "Email" - } - }, - "required": ["title", "input", "category"], - "x-stoplight": { - "id": "gest5kbecpjdi" - } - }, - "Project": { - "description": "Model for Project", - "examples": [ - { - "bases": [ - { - "alias": "string", - "config": null, - "enabled": true, - "id": "string", - "inflection_column": "camelize", - "inflection_table": "camelize", - "is_meta": true, - "order": 1, - "project_id": "string", - "type": "mysql2", - "updated_at": "2023-03-01 14:27:36" - } - ], - "color": "#24716E", - "created_at": "2023-03-01 14:27:36", - "deleted": true, - "description": "This is my project description", - "id": "p_124hhlkbeasewh", - "is_meta": true, - "meta": {}, - "order": 0, - "prefix": "nc_vm5q__", - "status": "string", - "title": "my-project" - } - ], - "title": "Project Model", - "type": "object", - "properties": { - "bases": { - "description": "List of base models", - "type": "array", - "items": { - "$ref": "#/components/schemas/Base" - } - }, - "color": { - "description": "Primary Theme Color", - "example": "#24716E", - "type": "string" - }, - "deleted": { - "$ref": "#/components/schemas/Bool", - "description": "Is the project deleted" - }, - "description": { - "description": "Project Description", - "example": "This is my project description", - "type": "string" - }, - "id": { - "description": "Unique Project ID", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "is_meta": { - "$ref": "#/components/schemas/Bool" - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "description": "Meta Info such as theme colors" - }, - "order": { - "description": "The order in project list", - "type": "number" - }, - "prefix": { - "description": "Project prefix. Used in XCDB only.", - "example": "nc_vm5q__", - "type": "string" - }, - "status": { - "type": "string" - }, - "title": { - "description": "Project Title", - "example": "my-project", - "type": "string" - } - }, - "x-stoplight": { - "id": "gae6rj3whdnj9" - } - }, - "ProjectList": { - "description": "Model for Project List", - "examples": [ - { - "list": [ - { - "bases": [ - { - "alias": "string", - "config": null, - "created_at": "2023-03-01 14:27:36", - "enabled": true, - "id": "string", - "inflection_column": "camelize", - "inflection_table": "camelize", - "is_meta": true, - "order": 1, - "project_id": "string", - "type": "mysql2", - "updated_at": "2023-03-01 14:27:36" - } - ], - "color": "#24716E", - "created_at": "2023-03-01 14:27:36", - "deleted": true, - "description": "This is my project description", - "id": "p_124hhlkbeasewh", - "is_meta": true, - "meta": {}, - "order": 0, - "prefix": "nc_vm5q__", - "status": "string", - "title": "my-project", - "updated_at": "2023-03-01 14:27:36" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - ], - "title": "Project List Model", - "type": "object", - "x-examples": { - "example-1": { - "bases": { - "list": [ - { - "alias": "string", - "database": "string", - "host": "string", - "id": "string", - "params": "string", - "password": "string", - "port": 0, - "project_id": "string", - "ssl": "string", - "type": "string", - "url": "string", - "username": "string" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "pageSize": 0, - "sort": "string", - "totalRows": 0 - } - } - } - }, - "properties": { - "list": { - "description": "List of Project Models", - "minItems": 1, - "type": "array", - "uniqueItems": true, - "items": { - "$ref": "#/components/schemas/Project" - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated", - "description": "Pagination Info" - } - }, - "required": ["list", "pageInfo"], - "x-stoplight": { - "id": "xbosckfm1h9l0" - } - }, - "ProjectReq": { - "description": "Model for Project Request", - "examples": [ - { - "bases": [ - { - "alias": "My Base", - "config": null, - "inflection_column": "camelize", - "inflection_table": "camelize", - "is_meta": true, - "type": "mysql" - } - ], - "color": "#24716E", - "description": "This is my project description", - "title": "My Project" - } - ], - "properties": { - "bases": { - "description": "Array of Bases", - "items": { - "$ref": "#/components/schemas/BaseReq" - }, - "type": "array" - }, - "color": { - "description": "Primary Theme Color", - "example": "#24716E", - "maxLength": 50, - "type": "string" - }, - "description": { - "description": "Project Description", - "example": "This is my project description", - "type": "string" - }, - "title": { - "description": "Project Title", - "example": "My Project", - "maxLength": 128, - "minLength": 1, - "type": "string" - } - }, - "required": ["title"], - "title": "Project Request Model", - "type": "object", - "x-stoplight": { - "id": "aicbp4keo57ld" - } - }, - "ProjectUpdateReq": { - "description": "Model for Project Update Request", - "x-stoplight": { - "id": "83257b35r118q" - }, - "examples": [ - { - "color": "#24716E", - "meta": null, - "title": "My Project" - } - ], - "title": "Project Update Request Model", - "type": "object", - "properties": { - "color": { - "description": "Primary Theme Color", - "example": "#24716E", - "maxLength": 50, - "type": "string" - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "description": "Project Meta", - "x-stoplight": { - "id": "m05w9sbwqgul3" - } - }, - "title": { - "description": "Project Title", - "example": "My Project", - "maxLength": 128, - "minLength": 1, - "type": "string" - } - } - }, - "ProjectUserReq": { - "description": "Model for Project User Request", - "examples": [ - { - "email": "user@example.com", - "roles": "owner" - } - ], - "title": "Project User Request Model", - "type": "object", - "properties": { - "email": { - "format": "email", - "type": "string", - "description": "Project User Email" - }, - "roles": { - "enum": [ - "commenter", - "editor", - "guest", - "owner", - "viewer", - "creator" - ], - "type": "string", - "description": "Project User Role" - } - }, - "required": ["email", "roles"], - "x-stoplight": { - "id": "tq2wpd2agebjz" - } - }, - "Rollup": { - "description": "Model for Rollup", - "examples": [ - { - "id": "rl_kc19pbdkij8wly", - "fk_column_id": "cl_588b63mneri2yi", - "fk_relation_column_id": "cl_c09q6eu6hsvn4s", - "fk_rollup_column_id": "cl_m62i1vyl23n8co", - "rollup_function": "count" - } - ], - "title": "Rollup Model", - "type": "object", - "properties": { - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "fk_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Column" - }, - "fk_relation_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign to Relation Column" - }, - "fk_rollup_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign to Rollup Column" - }, - "rollup_function": { - "type": "string", - "description": "Rollup Function", - "example": "count", - "enum": [ - "count", - "min", - "max", - "avg", - "countDistinct", - "sumDistinct", - "avgDistinct" - ] - } - }, - "x-stoplight": { - "id": "vdzh0qojyn9a9" - } - }, - "RollupColumnReq": { - "description": "Model for Rollup Column Request", - "examples": [ - { - "fk_relation_column_id": "cl_c09q6eu6hsvn4s", - "fk_rollup_column_id": "cl_m62i1vyl23n8co", - "title": "Rollup Column", - "rollup_function": "avg", - "uidt": "Rollup" - } - ], - "title": "Rollup Column Request Model", - "type": "object", - "properties": { - "fk_relation_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Relation Column" - }, - "fk_rollup_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Rollup Column" - }, - "title": { - "maxLength": 255, - "type": "string", - "description": "Rollup Column Title" - }, - "rollup_function": { - "enum": [ - "avg", - "avgDistinct", - "count", - "countDistinct", - "max", - "min", - "sum", - "sumDistinct" - ], - "type": "string", - "description": "Rollup Function" - }, - "uidt": { - "enum": ["Rollup"], - "type": "string", - "description": "UI DataType" - } - }, - "x-stoplight": { - "id": "uw9fq6lp1lone" - } - }, - "SelectOption": { - "description": "Model for SelectOption", - "examples": [ - { - "id": "sl_hvfeuagqtlzzbk", - "title": "Option A", - "fk_column_id": "cl_35zmvi2tezfipw", - "color": "#cfdffe", - "order": 1 - } - ], - "title": "SelectOption Model", - "type": "object", - "properties": { - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "title": { - "type": "string", - "description": "Option Title\n", - "example": "Option A" - }, - "fk_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Column" - }, - "color": { - "type": "string", - "description": "Option Color", - "example": "#cfdffe" - }, - "order": { - "type": "number", - "description": "The order among the options", - "example": 1 - } - }, - "x-stoplight": { - "id": "onnh5qie1ul32" - } - }, - "SelectOptions": { - "description": "Model for SelectOptions", - "examples": [ - { - "options": [ - { - "id": "sl_hvfeuagqtlzzbk", - "title": "Option A", - "fk_column_id": "cl_35zmvi2tezfipw", - "color": "#cfdffe", - "order": 1 - } - ] - } - ], - "title": "SelectOptions Model", - "type": "object", - "properties": { - "options": { - "type": "array", - "description": "Array of select options", - "items": { - "$ref": "#/components/schemas/SelectOption" - } - } - }, - "required": ["options"], - "x-stoplight": { - "id": "3i68n0spduuf9" - } - }, - "SharedBaseReq": { - "description": "Model for Shared Base Request", - "examples": [ - { - "password": "password123", - "roles": "editor" - } - ], - "title": "Shared Base Request Model", - "type": "object", - "properties": { - "password": { - "minLength": 8, - "type": "string", - "description": "Password to protect the base", - "example": "password123" - }, - "roles": { - "enum": ["commenter", "editor", "viewer"], - "type": "string", - "description": "The role given the target user", - "example": "editor" - } - }, - "x-stoplight": { - "id": "ep7ikmx3sudcl" - } - }, - "SharedView": { - "$ref": "#/components/schemas/View", - "description": "Model for Shared View", - "title": "SharedView", - "examples": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:46:31", - "fk_model_id": "md_mhs9z4r2ak98x0", - "id": "vw_lg052cnc1c26kf", - "is_default": 1, - "lock_type": "collaborative", - "meta": {}, - "order": 1, - "password": null, - "project_id": "p_xm3thidrblw4n7", - "show": 1, - "show_system_fields": null, - "title": "Sheet-1", - "type": 3, - "updated_at": "2023-03-02 17:46:31", - "uuid": null, - "view": { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:46:31", - "fk_view_id": "vw_lg052cnc1c26kf", - "meta": null, - "project_id": "p_xm3thidrblw4n7", - "row_height": null, - "updated_at": "2023-03-02 17:46:31", - "uuid": null - } - } - ], - "x-stoplight": { - "id": "fqfohevz2zj4u" - } - }, - "SharedViewList": { - "description": "Model for Shared View List", - "examples": [ - { - "list": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:46:31", - "fk_model_id": "md_mhs9z4r2ak98x0", - "id": "vw_lg052cnc1c26kf", - "is_default": 1, - "lock_type": "collaborative", - "meta": {}, - "order": 1, - "password": null, - "project_id": "p_xm3thidrblw4n7", - "show": 1, - "show_system_fields": null, - "title": "Sheet-1", - "type": 3, - "updated_at": "2023-03-02 17:46:31", - "uuid": null, - "view": { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:46:31", - "fk_view_id": "vw_lg052cnc1c26kf", - "meta": null, - "project_id": "p_xm3thidrblw4n7", - "row_height": null, - "updated_at": "2023-03-02 17:46:31", - "uuid": null - } - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - ], - "title": "Shared View List Model", - "type": "object", - "x-examples": { - "example-1": { - "bases": { - "list": [ - { - "alias": "string", - "database": "string", - "host": "string", - "id": "string", - "params": "string", - "password": "string", - "port": 0, - "project_id": "string", - "ssl": "string", - "type": "string", - "url": "string", - "username": "string" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "pageSize": 0, - "sort": "string", - "totalRows": 0 - } - } - } - }, - "properties": { - "list": { - "minItems": 1, - "type": "array", - "uniqueItems": true, - "description": "List of shared view objects", - "items": { - "$ref": "#/components/schemas/SharedView" - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated", - "description": "Paginated Info" - } - }, - "required": ["list", "pageInfo"], - "x-stoplight": { - "id": "zdpekhmw0wvj3" - } - }, - "SharedViewReq": { - "description": "Model for Shared View Request", - "examples": [ - { - "meta": {}, - "password": "123456789" - } - ], - "title": "Shared View Request Model", - "type": "object", - "properties": { - "meta": { - "$ref": "#/components/schemas/Meta", - "description": "Meta data passing to Shared View such as if download is allowed or not." - }, - "password": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Password to restrict access" - } - }, - "x-stoplight": { - "id": "0g3o2uo9y4h4g" - } - }, - "SignInReq": { - "description": "Model for Signin Request", - "examples": [ - { - "email": "user@example.com", - "password": "string" - } - ], - "properties": { - "email": { - "description": "Email address of the user", - "format": "email", - "type": "string" - }, - "password": { - "description": "Password of the user", - "type": "string" - } - }, - "required": ["email", "password"], - "title": "Signin Request Model", - "type": "object", - "x-stoplight": { - "id": "dxxafjky40cz1" - } - }, - "SignUpReq": { - "description": "Model for Signup Request", - "examples": [ - { - "email": "user@example.com", - "password": "password123456789", - "firstname": "Alice", - "lastname": "Smith", - "token": null, - "ignore_subscribe": 0 - } - ], - "title": "Signup Request Model", - "type": "object", - "properties": { - "email": { - "description": "Email address of the user", - "example": "user@example.com", - "format": "email", - "type": "string" - }, - "password": { - "description": "Password of the user", - "example": "password123456789", - "minLength": 8, - "type": "string" - }, - "firstname": { - "$ref": "#/components/schemas/StringOrNull", - "x-stoplight": { - "id": "lblivgs8wcsm1" - } - }, - "lastname": { - "$ref": "#/components/schemas/StringOrNull", - "x-stoplight": { - "id": "d4341r35tucq3" - } - }, - "token": { - "$ref": "#/components/schemas/StringOrNull", - "x-stoplight": { - "id": "otw9jgnr9n7c4" - }, - "description": "Sign Up Token. Used for invitation." - }, - "ignore_subscribe": { - "$ref": "#/components/schemas/Bool", - "x-stoplight": { - "id": "g7ge6mc6vdsds" - }, - "description": "Ignore Subscription" - } - }, - "required": ["email", "password"], - "x-stoplight": { - "id": "2rcbk0flkc4yu" - } - }, - "Sort": { - "description": "Model for Sort", - "examples": [ - { - "id": "so_xd4t51uv60ghzl", - "fk_column_id": "cl_l11b769pe2j1ce", - "fk_model_id": "md_ehn5izr99m7d45", - "base_id": "ds_3l9qx8xqksenrl", - "direction": "desc", - "order": 1, - "project_id": "p_9sx43moxhqtjm3" - } - ], - "title": "Sort Model", - "type": "object", - "properties": { - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "fk_column_id": { - "$ref": "#/components/schemas/Id" - }, - "fk_model_id": { - "$ref": "#/components/schemas/Id" - }, - "base_id": { - "type": "string", - "description": "Base ID", - "example": "ds_3l9qx8xqksenrl", - "readOnly": true - }, - "direction": { - "type": "string", - "description": "Sort direction", - "enum": ["asc", "desc"], - "example": "desc" - }, - "order": { - "type": "number", - "example": 1 - }, - "project_id": { - "type": "string", - "description": "Project ID", - "example": "p_9sx43moxhqtjm3", - "readOnly": true - } - }, - "x-stoplight": { - "id": "3jjbe2mjzy5li" - } - }, - "SortList": { - "description": "Model for Sort List", - "examples": [ - { - "list": [ - { - "id": "so_xd4t51uv60ghzl", - "fk_column_id": "cl_l11b769pe2j1ce", - "fk_model_id": "md_ehn5izr99m7d45", - "base_id": "ds_3l9qx8xqksenrl", - "direction": "desc", - "order": 1, - "project_id": "p_9sx43moxhqtjm3" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - ], - "title": "Sort List Model", - "type": "object", - "x-examples": { - "example-1": { - "bases": { - "list": [ - { - "alias": "string", - "database": "string", - "host": "string", - "id": "string", - "params": "string", - "password": "string", - "port": 0, - "project_id": "string", - "ssl": "string", - "type": "string", - "url": "string", - "username": "string" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "pageSize": 0, - "sort": "string", - "totalRows": 0 - } - } - } - }, - "properties": { - "list": { - "type": "array", - "x-stoplight": { - "id": "gjqqc8ciqg947" - }, - "description": "List of Sort Objects", - "items": { - "$ref": "#/components/schemas/Sort", - "x-stoplight": { - "id": "usnfa1kbovpmb" - } - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated", - "x-stoplight": { - "id": "i75wcejfp5mnq" - } - } - }, - "required": ["list", "pageInfo"], - "x-stoplight": { - "id": "fsq6d3pi8b3iz" - } - }, - "SortReq": { - "description": "Model for Sort Request", - "examples": [ - { - "direction": "asc", - "fk_column_id": "cl_l11b769pe2j1ce" - } - ], - "minProperties": 1, - "title": "Sort Request Model", - "type": "object", - "properties": { - "fk_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Column" - }, - "direction": { - "description": "Sort direction", - "enum": ["asc", "desc"], - "type": "string" - } - }, - "x-stoplight": { - "id": "lao7jfow2dbe7" - } - }, - "StringOrNull": { - "description": "Model for StringOrNull", - "examples": ["string"], - "oneOf": [ - { - "maxLength": 255, - "type": "string" - }, - { - "type": "null" - } - ], - "title": "StringOrNull Model", - "x-stoplight": { - "id": "xh9dwrizrvfh6" - } - }, - "Table": { - "description": "Model for Table", - "examples": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "columns": [ - { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": "CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP", - "clen": null, - "column_name": "updated_at", - "cop": "4", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "timestamp", - "deleted": null, - "dt": "timestamp", - "dtx": "specificType", - "dtxp": "0", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_m4wkaqgqqjzoeh", - "meta": null, - "np": null, - "ns": null, - "order": 4, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 0, - "system": 0, - "title": "UpdatedAt", - "uidt": "DateTime", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": "CURRENT_TIMESTAMP", - "clen": null, - "column_name": "created_at", - "cop": "3", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "timestamp", - "deleted": null, - "dt": "timestamp", - "dtx": "specificType", - "dtxp": "0", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_jpl0qu4gj4rexq", - "meta": null, - "np": null, - "ns": null, - "order": 3, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 0, - "system": 0, - "title": "CreatedAt", - "uidt": "DateTime", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": null, - "clen": "45", - "column_name": "title", - "cop": "2", - "created_at": "2023-03-02 17:04:06", - "csn": "utf8mb4", - "ct": "varchar(45)", - "deleted": null, - "dt": "varchar", - "dtx": "specificType", - "dtxp": "45", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_c5knoi4xs4sfpt", - "meta": null, - "np": null, - "ns": null, - "order": 2, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": 1, - "rqd": 0, - "system": 0, - "title": "Title", - "uidt": "SingleLineText", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - { - "ai": 1, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": null, - "clen": null, - "column_name": "id", - "cop": "1", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "int unsigned", - "deleted": null, - "dt": "int", - "dtx": "specificType", - "dtxp": "", - "dtxs": "0", - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_phvuuwjrzcdo0g", - "meta": null, - "np": "10", - "ns": "0", - "order": 1, - "pk": 1, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 1, - "system": 0, - "title": "Id", - "uidt": "ID", - "un": 1, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - } - ], - "columnsById": { - "cl_c5knoi4xs4sfpt": { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": null, - "clen": "45", - "column_name": "title", - "cop": "2", - "created_at": "2023-03-02 17:04:06", - "csn": "utf8mb4", - "ct": "varchar(45)", - "deleted": null, - "dt": "varchar", - "dtx": "specificType", - "dtxp": "45", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_c5knoi4xs4sfpt", - "meta": null, - "np": null, - "ns": null, - "order": 2, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": 1, - "rqd": 0, - "system": 0, - "title": "Title", - "uidt": "SingleLineText", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - "cl_jpl0qu4gj4rexq": { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": "CURRENT_TIMESTAMP", - "clen": null, - "column_name": "created_at", - "cop": "3", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "timestamp", - "deleted": null, - "dt": "timestamp", - "dtx": "specificType", - "dtxp": "0", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_jpl0qu4gj4rexq", - "meta": null, - "np": null, - "ns": null, - "order": 3, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 0, - "system": 0, - "title": "CreatedAt", - "uidt": "DateTime", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - "cl_m4wkaqgqqjzoeh": { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": "CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP", - "clen": null, - "column_name": "updated_at", - "cop": "4", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "timestamp", - "deleted": null, - "dt": "timestamp", - "dtx": "specificType", - "dtxp": "0", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_m4wkaqgqqjzoeh", - "meta": null, - "np": null, - "ns": null, - "order": 4, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 0, - "system": 0, - "title": "UpdatedAt", - "uidt": "DateTime", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - "cl_phvuuwjrzcdo0g": { - "ai": 1, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": null, - "clen": null, - "column_name": "id", - "cop": "1", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "int unsigned", - "deleted": null, - "dt": "int", - "dtx": "specificType", - "dtxp": "", - "dtxs": "0", - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_phvuuwjrzcdo0g", - "meta": null, - "np": "10", - "ns": "0", - "order": 1, - "pk": 1, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 1, - "system": 0, - "title": "Id", - "uidt": "ID", - "un": 1, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - } - }, - "created_at": "2023-03-02 17:04:06", - "deleted": null, - "enabled": 1, - "id": "md_rsu68aqjsbyqtl", - "meta": null, - "mm": 0, - "order": 1, - "pinned": null, - "project_id": "p_xm3thidrblw4n7", - "schema": null, - "table_name": "nc_vm5q___Table1", - "tags": null, - "title": "Table1", - "type": "table", - "updated_at": "2023-03-02 17:04:08", - "views": [ - { - "_ptn": "Table1", - "_tn": "Table1", - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:04:06", - "disabled": { - "commenter": false, - "creator": false, - "editor": false, - "guest": false, - "owner": false, - "viewer": false - }, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "vw_p2jcatxz4mvcfw", - "is_default": 1, - "lock_type": "collaborative", - "meta": {}, - "order": 1, - "password": null, - "project_id": "p_xm3thidrblw4n7", - "ptn": "nc_vm5q___Table1", - "ptype": "table", - "show": 1, - "show_system_fields": null, - "table_meta": null, - "title": "Table1", - "tn": "Table1", - "type": 3, - "updated_at": "2023-03-02 17:04:06", - "uuid": null, - "view": { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:04:06", - "fk_view_id": "vw_p2jcatxz4mvcfw", - "meta": null, - "project_id": "p_xm3thidrblw4n7", - "row_height": null, - "updated_at": "2023-03-02 17:04:06", - "uuid": null - } - } - ] - } - ], - "title": "Table Model", - "type": "object", - "properties": { - "base_id": { - "description": "Unique Base ID", - "type": "string" - }, - "columns": { - "description": "The columns included in this table", - "type": "array", - "items": { - "$ref": "#/components/schemas/Column" - } - }, - "columnsById": { - "description": "Column Models grouped by IDs", - "type": "object" - }, - "deleted": { - "$ref": "#/components/schemas/Bool" - }, - "enabled": { - "$ref": "#/components/schemas/Bool", - "description": "Is this table enabled?" - }, - "id": { - "description": "Unique Table ID", - "type": "string" - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "description": "Meta Data" - }, - "mm": { - "$ref": "#/components/schemas/Bool", - "description": "Is this table used for M2M" - }, - "order": { - "description": "The order of the list of tables", - "type": "number" - }, - "pinned": { - "$ref": "#/components/schemas/Bool", - "description": "Currently not in use" - }, - "project_id": { - "description": "Unique Project ID", - "type": "string" - }, - "table_name": { - "description": "Table Name. Prefix will be added for XCDB projects.", - "type": "string" - }, - "tags": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Currently not in use" - }, - "title": { - "description": "Table Title", - "type": "string" - }, - "type": { - "description": "Table Type", - "type": "string" - } - }, - "required": ["table_name", "title"], - "x-stoplight": { - "id": "rvdu5okgpz1xk" - } - }, - "TableList": { - "description": "Model for Table List", - "examples": [ - { - "list": [ - { - "alias": "string", - "base_id": "string", - "column": [ - { - "alias": "string", - "auto_increment": true, - "auto_update_timestamp": true, - "base_id": "string", - "character_maximum_length": "string", - "character_set_name": "string", - "colOptions": { - "deleted": "string", - "dr": "string", - "fk_child_column_id": "string", - "fk_column_id": "string", - "fk_index_name": "string", - "fk_mm_child_column_id": "string", - "fk_mm_model_id": "string", - "fk_mm_parent_column_id": "string", - "fk_parent_column_id": "string", - "id": "string", - "order": "string", - "type": "string", - "ur": "string", - "virtual": true - }, - "column_comment": "string", - "column_default": "string", - "column_ordinal_position": "string", - "column_type": "string", - "data_type": "string", - "data_type_x": "string", - "data_type_x_precision": "string", - "data_type_x_scale": "string", - "deleted": true, - "fk_model_id": "string", - "id": "string", - "numeric_precision": "string", - "numeric_scale": "string", - "order": 0, - "primary_key": true, - "primary_value": true, - "rqd": "string", - "title": "string", - "ui_data_type": "string", - "un": "string", - "unique": true, - "visible": true - } - ], - "columnByIds": {}, - "deleted": true, - "enabled": true, - "id": "string", - "order": 0, - "parent_id": "string", - "pinned": true, - "project_id": "string", - "show_as": "string", - "tags": "string", - "title": "string", - "type": "string" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - ], - "title": "Table List Model", - "type": "object", - "x-examples": { - "example-1": { - "bases": { - "list": [ - { - "alias": "string", - "database": "string", - "host": "string", - "id": "string", - "params": "string", - "password": "string", - "port": 0, - "project_id": "string", - "ssl": "string", - "type": "string", - "url": "string", - "username": "string" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "pageSize": 0, - "sort": "string", - "totalRows": 0 - } - } - } - }, - "properties": { - "list": { - "minItems": 1, - "type": "array", - "uniqueItems": true, - "description": "List of table objects", - "items": { - "$ref": "#/components/schemas/Table" - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated", - "description": "Paginated Info" - } - }, - "required": ["list", "pageInfo"], - "x-stoplight": { - "id": "25z7dodhqs3lc" - } - }, - "TableReq": { - "description": "Model for Table Request", - "examples": [ - { - "columns": [ - { - "ai": false, - "altered": 1, - "cdf": "CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP", - "ck": false, - "clen": 45, - "column_name": "updated_at", - "ct": "varchar(45)", - "dt": "timestamp", - "dtx": "specificType", - "dtxp": "", - "dtxs": "", - "np": null, - "nrqd": true, - "ns": null, - "pk": false, - "rqd": false, - "title": "UpdatedAt", - "uicn": "", - "uidt": "DateTime", - "uip": "", - "un": false - }, - { - "ai": false, - "altered": 1, - "cdf": "CURRENT_TIMESTAMP", - "ck": false, - "clen": 45, - "column_name": "created_at", - "ct": "varchar(45)", - "dt": "timestamp", - "dtx": "specificType", - "dtxp": "", - "dtxs": "", - "np": null, - "nrqd": true, - "ns": null, - "pk": false, - "rqd": false, - "title": "CreatedAt", - "uicn": "", - "uidt": "DateTime", - "uip": "", - "un": false - }, - { - "ai": false, - "altered": 1, - "cdf": null, - "ck": false, - "clen": 45, - "column_name": "title", - "ct": "varchar(45)", - "dt": "varchar", - "dtx": "specificType", - "dtxp": "45", - "dtxs": "", - "np": null, - "nrqd": true, - "ns": null, - "pk": false, - "rqd": false, - "title": "Title", - "uicn": "", - "uidt": "SingleLineText", - "uip": "", - "un": false - }, - { - "ai": true, - "altered": 1, - "cdf": null, - "ck": false, - "clen": null, - "column_name": "id", - "ct": "int(11)", - "dt": "int", - "dtx": "integer", - "dtxp": "11", - "dtxs": "", - "np": 11, - "nrqd": false, - "ns": 0, - "pk": true, - "rqd": true, - "title": "Id", - "uicn": "", - "uidt": "ID", - "uip": "", - "un": true - } - ], - "table_name": "Sheet-1", - "title": "Sheet-1" - } - ], - "properties": { - "columns": { - "description": "The column models in this table", - "items": { - "$ref": "#/components/schemas/NormalColumnRequest" - }, - "type": "array" - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "description": "the meta data for this table" - }, - "order": { - "description": "The order of table list", - "example": 1, - "type": "number" - }, - "table_name": { - "description": "Table name", - "example": "my_table", - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "title": { - "description": "Table title", - "example": "My Table", - "maxLength": 255, - "minLength": 0, - "type": "string" - } - }, - "required": ["columns", "table_name"], - "title": "Table Request Model", - "type": "object", - "x-stoplight": { - "id": "kilqakhuuzstv" - } - }, - "User": { - "description": "Model for User", - "examples": [ - { - "email": "user@example.com", - "email_verified": true, - "firstname": "Alice", - "id": "us_8kugj628ebjngs", - "lastname": "Smith", - "roles": "org-level-viewer" - } - ], - "title": "User Model", - "type": "object", - "x-internal": false, - "properties": { - "email": { - "description": "The email of the user", - "example": "user@example.com", - "format": "email", - "type": "string" - }, - "email_verified": { - "description": "Set to true if the user's email has been verified.", - "type": "boolean" - }, - "firstname": { - "description": "The first name of the user", - "example": "Alice", - "type": "string" - }, - "id": { - "description": "Unique identifier for the given user.", - "example": "us_8kugj628ebjngs", - "type": "string" - }, - "lastname": { - "description": "The last name of the user", - "example": "Smith", - "type": "string" - }, - "roles": { - "description": "The roles of the user", - "example": "org-level-viewer", - "type": "string" - } - }, - "required": ["email", "email_verified", "firstname", "id", "lastname"], - "x-stoplight": { - "id": "nwug6wvbc5yrp" - } - }, - "UserInfo": { - "description": "Model for User Info", - "examples": [ - { - "email": "user@example.com", - "email_verified": true, - "firstname": "string", - "id": "string", - "lastname": "string", - "roles": null - } - ], - "properties": { - "email": { - "description": "User Email", - "format": "email", - "type": "string" - }, - "email_verified": { - "description": "Set to true if the user's email has been verified.", - "type": "boolean" - }, - "firstname": { - "description": "The firstname of the user", - "type": "string" - }, - "id": { - "description": "User ID", - "type": "string" - }, - "lastname": { - "description": "The lastname of the user", - "type": "string" - }, - "roles": { - "description": "The roles of the user" - } - }, - "title": "User Info Model", - "type": "object", - "x-stoplight": { - "id": "qravubcoxvr6x" - } - }, - "UserList": { - "description": "Model for User List", - "examples": [ - { - "list": [ - { - "email": "user@example.com", - "email_verified": true, - "firstname": "Alice", - "id": "us_8kugj628ebjngs", - "lastname": "Smith", - "roles": "org-level-viewer" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - ], - "title": "User List Model", - "type": "object", - "x-examples": { - "example-1": { - "bases": { - "list": [ - { - "alias": "string", - "database": "string", - "host": "string", - "id": "string", - "params": "string", - "password": "string", - "port": 0, - "project_id": "string", - "ssl": "string", - "type": "string", - "url": "string", - "username": "string" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "pageSize": 0, - "sort": "string", - "totalRows": 0 - } - } - } - }, - "properties": { - "list": { - "type": "array", - "x-stoplight": { - "id": "8o7v47q3e67ef" - }, - "description": "List of user objects", - "items": { - "$ref": "#/components/schemas/User", - "x-stoplight": { - "id": "kwqzxwea9r5er" - } - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated", - "x-stoplight": { - "id": "0d98n6sfxfvft" - }, - "description": "Paginated Info" - } - }, - "required": ["list", "pageInfo"], - "x-stoplight": { - "id": "11epslmm9jcga" - } - }, - "View": { - "description": "Model for View", - "examples": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:46:31", - "fk_model_id": "md_mhs9z4r2ak98x0", - "id": "vw_lg052cnc1c26kf", - "is_default": 1, - "lock_type": "collaborative", - "meta": {}, - "order": 1, - "password": null, - "project_id": "p_xm3thidrblw4n7", - "show": 1, - "show_system_fields": null, - "title": "Sheet-1", - "type": 3, - "updated_at": "2023-03-02 17:46:31", - "uuid": null, - "view": { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:46:31", - "fk_view_id": "vw_lg052cnc1c26kf", - "meta": null, - "project_id": "p_xm3thidrblw4n7", - "row_height": null, - "updated_at": "2023-03-02 17:46:31", - "uuid": null - } - } - ], - "title": "View Model", - "type": "object", - "properties": { - "base_id": { - "$ref": "#/components/schemas/Id", - "description": "Unique Base ID" - }, - "fk_model_id": { - "$ref": "#/components/schemas/Id", - "description": "Unique Model ID" - }, - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID for View" - }, - "lock_type": { - "description": "Lock Type of the view", - "enum": ["collaborative", "locked", "personal"], - "type": "string" - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "description": "Meta data for this view" - }, - "order": { - "description": "The rder of the list of views", - "type": "number" - }, - "password": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Password for protecting the view" - }, - "project_id": { - "$ref": "#/components/schemas/Id", - "description": "Unique Project ID" - }, - "show": { - "$ref": "#/components/schemas/Bool", - "description": "If this view is shown?" - }, - "show_system_fields": { - "$ref": "#/components/schemas/Bool", - "description": "Should show system fields in this view?" - }, - "is_default": { - "$ref": "#/components/schemas/Bool", - "description": "Is this view default view for the model?" - }, - "title": { - "description": "View Title", - "type": "string" - }, - "type": { - "description": "View Type", - "type": "number" - }, - "uuid": { - "$ref": "#/components/schemas/StringOrNull", - "description": "UUID of the view" - }, - "view": { - "anyOf": [ - { - "$ref": "#/components/schemas/Form" - }, - { - "$ref": "#/components/schemas/Gallery" - }, - { - "$ref": "#/components/schemas/Grid" - }, - { - "$ref": "#/components/schemas/Kanban" - }, - { - "$ref": "#/components/schemas/Map" - } - ], - "description": "Associated View Model" - } - }, - "required": ["fk_model_id", "show", "title", "type"], - "x-stoplight": { - "id": "pbahdgaroikdz" - } - }, - "ViewList": { - "description": "Model for View List", - "examples": [ - { - "list": [ - { - "alias": "string", - "column": [ - { - "alias": "string", - "auto_increment": true, - "auto_update_timestamp": true, - "base_id": "string", - "character_maximum_length": "string", - "character_set_name": "string", - "colOptions": { - "deleted": "string", - "dr": "string", - "fk_child_column_id": "string", - "fk_column_id": "string", - "fk_index_name": "string", - "fk_mm_child_column_id": "string", - "fk_mm_model_id": "string", - "fk_mm_parent_column_id": "string", - "fk_parent_column_id": "string", - "id": "string", - "order": "string", - "type": "string", - "ur": "string", - "virtual": true - }, - "column_comment": "string", - "column_default": "string", - "column_ordinal_position": "string", - "column_type": "string", - "data_type": "string", - "data_type_x": "string", - "data_type_x_precision": "string", - "data_type_x_scale": "string", - "deleted": true, - "fk_model_id": "string", - "id": "string", - "numeric_precision": "string", - "numeric_scale": "string", - "order": 0, - "primary_key": true, - "primary_value": true, - "rqd": "string", - "title": "string", - "ui_data_type": "string", - "un": "string", - "unique": true, - "visible": true - } - ], - "columnByIds": {}, - "deleted": true, - "enabled": true, - "fk_base_id": "string", - "fk_project_id": "string", - "id": "string", - "order": 0, - "parent_id": "string", - "pinned": true, - "show_as": "string", - "tags": "string", - "title": "string", - "type": "string" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - ], - "title": "View List Model", - "type": "object", - "x-examples": { - "example-1": { - "bases": { - "list": [ - { - "alias": "string", - "database": "string", - "host": "string", - "id": "string", - "params": "string", - "password": "string", - "port": 0, - "project_id": "string", - "ssl": "string", - "type": "string", - "url": "string", - "username": "string" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "pageSize": 0, - "sort": "string", - "totalRows": 0 - } - } - } - }, - "properties": { - "list": { - "type": "array", - "description": "List of view objects", - "items": { - "$ref": "#/components/schemas/View" - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated", - "description": "Paginated Info" - } - }, - "required": ["list", "pageInfo"], - "x-stoplight": { - "id": "5wwtppugkhbeh" - } - }, - "ViewCreateReq": { - "type": "object", - "x-stoplight": { - "id": "lksv99846uy60" - }, - "title": "ViewCreateReq", - "description": "Model for View Create Request", - "examples": [ - { - "title": "My Grid View", - "type": 3, - "copy_from_id": null, - "fk_grp_col_id": null, - "fk_geo_data_col_id": null - }, - { - "title": "My Gallery View", - "type": 2, - "copy_from_id": null, - "fk_grp_col_id": null, - "fk_geo_data_col_id": null - }, - { - "title": "My Form View", - "type": 1, - "copy_from_id": null, - "fk_grp_col_id": null, - "fk_geo_data_col_id": null - }, - { - "title": "My Kanban View", - "type": 4, - "copy_from_id": null, - "fk_grp_col_id": "cl_g0a89q9xdry3lu", - "fk_geo_data_col_id": null - }, - { - "title": "My Map View", - "type": 5, - "copy_from_id": null, - "fk_grp_col_id": null, - "fk_geo_data_col_id": "cl_uu1meolj00tlrq" - } - ], - "properties": { - "title": { - "type": "string", - "description": "View Title", - "example": "My View" - }, - "type": { - "type": "number", - "description": "View Type" - }, - "copy_from_id": { - "$ref": "#/components/schemas/StringOrNull", - "description": "ID of view to be copied from. Used in Copy View." - }, - "fk_grp_col_id": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Foreign Key to Grouping Column. Used in creating Kanban View." - }, - "fk_geo_data_col_id": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Foreign Key to Geo Data Column. Used in creating Map View." - } - }, - "required": ["title"] - }, - "ViewUpdateReq": { - "description": "Model for View Update Request", - "x-stoplight": { - "id": "1enlswadfc6p5" - }, - "examples": [ - { - "title": "Grid View 1", - "uuid": "e2457bbf-e29c-4fec-866e-fe3b01dba57f", - "password": "password123", - "lock_type": "collaborative", - "meta": "{\"allowCSVDownload\":true}", - "order": 1, - "show_system_fields": 0 - } - ], - "title": "View Update Request Model", - "type": "object", - "properties": { - "title": { - "maxLength": 255, - "type": "string", - "description": "View Title", - "example": "Grid View 1" - }, - "uuid": { - "maxLength": 255, - "type": "string", - "x-stoplight": { - "id": "vlhs7xs644u8l" - }, - "description": "View UUID. Used in Shared View.", - "example": "e2457bbf-e29c-4fec-866e-fe3b01dba57f" - }, - "password": { - "maxLength": 255, - "type": "string", - "x-stoplight": { - "id": "vlhs7xs644u8l" - }, - "description": "View Password. Used in Shared View.", - "example": "password123" - }, - "lock_type": { - "enum": ["collaborative", "locked", "personal"], - "type": "string", - "description": "Lock type of View.", - "example": "collaborative" - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "description": "Meta info used in View." - }, - "order": { - "type": "number", - "description": "The order of the list of views.", - "example": 1, - "minimum": 0 - }, - "show_system_fields": { - "$ref": "#/components/schemas/Bool", - "description": "Should this view show system fields?" - } - } - }, - "ViewColumnUpdateReq": { - "description": "Model for View Column Update Request", - "x-stoplight": { - "id": "ifzuv29axterb" - }, - "examples": [ - { - "show": 0, - "order": 1 - } - ], - "title": "View Column Update Request Model", - "type": "object", - "properties": { - "show": { - "$ref": "#/components/schemas/Bool", - "description": "View Title", - "x-stoplight": { - "id": "coxius73ejq5x" - } - }, - "order": { - "type": "number", - "description": "The order of the list of views.", - "example": 1, - "minimum": 0 - } - } - }, - "ViewColumnReq": { - "description": "Model for View Column Request", - "x-stoplight": { - "id": "z4bq84nyqkhd8" - }, - "examples": [ - { - "fk_column_id": "cl_5jestblzneb649", - "show": 0, - "order": 1 - } - ], - "title": "View Column Request Model", - "type": "object", - "properties": { - "fk_column_id": { - "$ref": "#/components/schemas/Id", - "x-stoplight": { - "id": "rxd07wvp9hf6s" - }, - "description": "Foreign Key to Column" - }, - "show": { - "$ref": "#/components/schemas/Bool", - "description": "View Title", - "x-stoplight": { - "id": "coxius73ejq5x" - } - }, - "order": { - "type": "number", - "description": "The order of the list of views.", - "example": 1, - "minimum": 0 - } - } - }, - "VisibilityRuleReq": { - "description": "Model for Visibility Rule Request", - "examples": [ - [ - { - "disabled": { - "commenter": true, - "creator": true, - "editor": true, - "guest": true, - "owner": true, - "viewer": true - } - } - ] - ], - "items": { - "properties": { - "id": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "disabled": { - "properties": { - "commenter": { - "$ref": "#/components/schemas/Bool" - }, - "creator": { - "$ref": "#/components/schemas/Bool" - }, - "editor": { - "$ref": "#/components/schemas/Bool" - }, - "guest": { - "$ref": "#/components/schemas/Bool" - }, - "owner": { - "$ref": "#/components/schemas/Bool" - }, - "viewer": { - "$ref": "#/components/schemas/Bool" - } - }, - "type": "object" - } - }, - "type": "object" - }, - "title": "Visibility Rule Request Model", - "type": "array", - "x-stoplight": { - "id": "vuo5q4vwtarx8" - } - } - }, - "responses": { - "ProjectList": { - "description": "Example response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProjectList" - }, - "examples": { - "example-1": { - "value": { - "list": [ - { - "bases": [ - { - "alias": "string", - "config": null, - "created_at": "2023-03-01 14:27:36", - "enabled": true, - "id": "string", - "inflection_column": "camelize", - "inflection_table": "camelize", - "is_meta": true, - "order": 1, - "project_id": "string", - "type": "mysql2", - "updated_at": "2023-03-01 14:27:36" - } - ], - "color": "#24716E", - "created_at": "2023-03-01 14:27:36", - "deleted": true, - "description": "This is my project description", - "id": "p_124hhlkbeasewh", - "is_meta": true, - "meta": {}, - "order": 0, - "prefix": "nc_vm5q__", - "status": "string", - "title": "my-project", - "updated_at": "2023-03-01 14:27:36" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "BaseList": { - "description": "Example response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BaseList" - }, - "examples": { - "example-1": { - "value": { - "list": [ - { - "id": "ds_krsappzu9f8vmo", - "project_id": "p_01clqvzik3izk6", - "alias": null, - "config": "", - "meta": null, - "is_meta": 1, - "type": "mysql2", - "inflection_column": "camelize", - "inflection_table": "camelize", - "created_at": "2023-03-01 16:31:49", - "updated_at": "2023-03-02 11:28:17", - "enabled": 1, - "order": 1 - }, - { - "id": "ds_btbdt19zde0gj9", - "project_id": "p_01clqvzik3izk6", - "alias": "sakila", - "config": "", - "meta": null, - "is_meta": null, - "type": "mysql2", - "inflection_column": "camelize", - "inflection_table": "camelize", - "created_at": "2023-03-02 11:28:17", - "updated_at": "2023-03-02 11:28:17", - "enabled": 1, - "order": 2 - } - ], - "pageInfo": { - "totalRows": 2, - "page": 1, - "pageSize": 2, - "isFirstPage": true, - "isLastPage": true - } - } - } - } - } - } - }, - "TableList": { - "description": "Example response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TableList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "id": "md_5hua2iqloqirhd", - "base_id": "ds_jxuewivwbxeum2", - "project_id": "p_tbhl1hnycvhe5l", - "table_name": "nc_b84e___Sheet-1", - "title": "Sheet-1", - "type": "table", - "meta": null, - "schema": null, - "enabled": true, - "mm": false, - "tags": null, - "pinned": null, - "deleted": null, - "order": 1, - "created_at": "2023-03-11T09:11:45.907Z", - "updated_at": "2023-03-11T09:11:45.907Z" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "ColumnList": { - "description": "Example response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ColumnList" - } - } - } - }, - "FilterList": { - "description": "Example response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FilterList" - } - } - } - }, - "SortList": { - "description": "Example response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SortList" - }, - "examples": {} - } - } - }, - "ViewList": { - "description": "Example response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ViewList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "alias": "string", - "column": [ - { - "alias": "string", - "auto_increment": true, - "auto_update_timestamp": true, - "base_id": "string", - "character_maximum_length": "string", - "character_set_name": "string", - "colOptions": { - "deleted": "string", - "dr": "string", - "fk_child_column_id": "string", - "fk_column_id": "string", - "fk_index_name": "string", - "fk_mm_child_column_id": "string", - "fk_mm_model_id": "string", - "fk_mm_parent_column_id": "string", - "fk_parent_column_id": "string", - "id": "string", - "order": "string", - "type": "string", - "ur": "string", - "virtual": true - }, - "column_comment": "string", - "column_default": "string", - "column_ordinal_position": "string", - "column_type": "string", - "data_type": "string", - "data_type_x": "string", - "data_type_x_precision": "string", - "data_type_x_scale": "string", - "deleted": true, - "fk_model_id": "string", - "id": "string", - "numeric_precision": "string", - "numeric_scale": "string", - "order": 0, - "primary_key": true, - "primary_value": true, - "rqd": "string", - "title": "string", - "ui_data_type": "string", - "un": "string", - "unique": true, - "visible": true - } - ], - "columnByIds": {}, - "deleted": true, - "enabled": true, - "fk_base_id": "string", - "fk_project_id": "string", - "id": "string", - "order": 0, - "parent_id": "string", - "pinned": true, - "show_as": "string", - "tags": "string", - "title": "string", - "type": "string" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "SharedViewList": { - "description": "Example response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SharedViewList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:46:31", - "fk_model_id": "md_mhs9z4r2ak98x0", - "id": "vw_lg052cnc1c26kf", - "is_default": 1, - "lock_type": "collaborative", - "meta": {}, - "order": 1, - "password": null, - "project_id": "p_xm3thidrblw4n7", - "show": 1, - "show_system_fields": null, - "title": "Sheet-1", - "type": 3, - "updated_at": "2023-03-02 17:46:31", - "uuid": null, - "view": { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:46:31", - "fk_view_id": "vw_lg052cnc1c26kf", - "meta": null, - "project_id": "p_xm3thidrblw4n7", - "row_height": null, - "updated_at": "2023-03-02 17:46:31", - "uuid": null - } - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "HookList": { - "description": "Example response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HookList" - } - } - } - }, - "UserList": { - "description": "Example response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UserList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "email": "user@example.com", - "email_verified": true, - "firstname": "Alice", - "id": "us_8kugj628ebjngs", - "lastname": "Smith", - "roles": "org-level-viewer" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "APITokenList": { - "description": "Example response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiTokenList" - }, - "examples": {} - } - }, - "type": "object", - "properties": { - "list": { - "type": "array", - "x-stoplight": { - "id": "uukp6v55zfp7i" - }, - "items": { - "$ref": "#/components/schemas/ApiToken", - "x-stoplight": { - "id": "9zqpoqfkdxy0y" - } - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated", - "x-stoplight": { - "id": "6unr17jyisial" - } - } - } - }, - "BadRequest": { - "description": "BadReqeust", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "p9mk4oi0hbihm" - }, - "example": "BadRequest [Error]: " - } - }, - "required": ["msg"] - }, - "examples": { - "Example 1": { - "value": { - "msg": "BadRequest [Error]: " - } - } - } - } - }, - "headers": {} - } - }, - "securitySchemes": { - "xc-auth": { - "name": "Auth Token ", - "type": "apiKey", - "in": "header", - "description": "Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable `NC_JWT_EXPIRES_IN`." - }, - "xc-shared-base-id": { - "name": "Shared Base ID", - "type": "apiKey", - "in": "header", - "description": "Shared base uuid" - } - }, - "parameters": { - "xc-auth": { - "name": "xc-auth", - "in": "header", - "required": false, - "schema": { - "type": "string" - }, - "description": "Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN." - } - } - } -}{ - "openapi": "3.1.0", - "info": { - "title": "nocodb", - "version": "1.0", - "description": "NocoDB API Documentation" - }, - "x-tagGroups": [ - { - "name": "Auth APIs", - "tags": ["Auth", "API Token"] - }, - { - "name": "Public APIs", - "tags": ["Public"] - }, - { - "name": "Data APIs", - "tags": ["DB Table Row", "DB View Row", "Storage"] - }, - { - "name": "Meta APIs", - "tags": [ - "Base", - "DB Table", - "DB Table Column", - "DB Table Filter", - "DB Table Sort", - "DB Table Webhook", - "DB Table Webhook Filter", - "DB View", - "DB View Column", - "DB View Share", - "Plugin", - "Project", - "Utils" - ] - }, - { - "name": "Organisation APIs", - "tags": ["Org App Settings", "Org License", "Org Tokens", "Org Users"] - } - ], - "servers": [ - { - "url": "http://localhost:8080" - } - ], - "paths": { - "/api/v1/auth/user/signup": { - "post": { - "summary": "Signup", - "operationId": "auth-signup", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "token": { - "type": "string", - "description": "The signed JWT token for information exchange", - "example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbWFpbCI6IndAbm9jb2RiLmNvbSIsImZpcnN0bmFtZSI6bnVsbCwibGFzdG5hbWUiOm51bGwsImlkIjoidXNfYjN4bzJpNDRueDV5OWwiLCJyb2xlcyI6Im9yZy1sZXZlbC1jcmVhdG9yLHN1cGVyIiwidG9rZW5fdmVyc2lvbiI6ImJmMTc3ZGUzYjk3YjAzMjY4YjU0NGZmMjMzNGU5YjFhMGUzYzgxM2NiYzliOTJkYWMwYmM5NTRiNmUzN2ZjMTJjYmFkNDM2NmIwYzExZTdjIiwiaWF0IjoxNjc4MDc4NDMyLCJleHAiOjE2NzgxMTQ0MzJ9.gzwp_svZlbA5PV_eawYV-9UFjZVjniy-tCDce16xrkI" - } - } - }, - "examples": { - "Example 1": { - "value": { - "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbWFpbCI6IndAbm9jb2RiLmNvbSIsImZpcnN0bmFtZSI6bnVsbCwibGFzdG5hbWUiOm51bGwsImlkIjoidXNfYjN4bzJpNDRueDV5OWwiLCJyb2xlcyI6Im9yZy1sZXZlbC1jcmVhdG9yLHN1cGVyIiwidG9rZW5fdmVyc2lvbiI6ImJmMTc3ZGUzYjk3YjAzMjY4YjU0NGZmMjMzNGU5YjFhMGUzYzgxM2NiYzliOTJkYWMwYmM5NTRiNmUzN2ZjMTJjYmFkNDM2NmIwYzExZTdjIiwiaWF0IjoxNjc4MDc4NDMyLCJleHAiOjE2NzgxMTQ0MzJ9.gzwp_svZlbA5PV_eawYV-9UFjZVjniy-tCDce16xrkI" - } - } - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string" - } - } - }, - "examples": { - "Invalid email": { - "value": { - "msg": "Invalid email" - } - }, - "Invalid invite url": { - "value": { - "msg": "Invalid invite url" - } - }, - "Expired invite url": { - "value": { - "msg": "Expired invite url, Please contact super admin to get a new invite url" - } - }, - "User already exist": { - "value": { - "msg": "User already exist" - } - }, - "Invite only signup": { - "value": { - "msg": "Not allowed to signup, contact super admin" - } - } - } - } - } - } - }, - "tags": ["Auth"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SignUpReq" - }, - "examples": { - "Example 1": { - "value": { - "email": "user@example.com", - "password": "password123456789", - "firstname": "Alice", - "lastname": "Smith", - "token": null, - "ignore_subscribe": 0 - } - } - } - } - } - }, - "description": "Create a new user with provided email and password and first user is marked as super admin. " - } - }, - "/api/v1/auth/user/signout": { - "post": { - "summary": "Signout", - "operationId": "auth-signout", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "description": "Success Message", - "example": "Signed out successfully" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "Signed out successfully" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Auth"], - "description": "Clear refresh token from the database and cookie." - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "/api/v1/auth/user/signin": { - "post": { - "summary": "Signin", - "operationId": "auth-signin", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "token": { - "type": "string", - "description": "The signed JWT token for information exchange", - "example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbWFpbCI6IndAbm9jb2RiLmNvbSIsImZpcnN0bmFtZSI6bnVsbCwibGFzdG5hbWUiOm51bGwsImlkIjoidXNfYjN4bzJpNDRueDV5OWwiLCJyb2xlcyI6Im9yZy1sZXZlbC1jcmVhdG9yLHN1cGVyIiwidG9rZW5fdmVyc2lvbiI6ImJmMTc3ZGUzYjk3YjAzMjY4YjU0NGZmMjMzNGU5YjFhMGUzYzgxM2NiYzliOTJkYWMwYmM5NTRiNmUzN2ZjMTJjYmFkNDM2NmIwYzExZTdjIiwiaWF0IjoxNjc4MDc4NDMyLCJleHAiOjE2NzgxMTQ0MzJ9.gzwp_svZlbA5PV_eawYV-9UFjZVjniy-tCDce16xrkI" - } - } - }, - "examples": { - "Example 1": { - "value": { - "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbWFpbCI6IndAbm9jb2RiLmNvbSIsImZpcnN0bmFtZSI6bnVsbCwibGFzdG5hbWUiOm51bGwsImlkIjoidXNfYjN4bzJpNDRueDV5OWwiLCJyb2xlcyI6Im9yZy1sZXZlbC1jcmVhdG9yLHN1cGVyIiwidG9rZW5fdmVyc2lvbiI6ImJmMTc3ZGUzYjk3YjAzMjY4YjU0NGZmMjMzNGU5YjFhMGUzYzgxM2NiYzliOTJkYWMwYmM5NTRiNmUzN2ZjMTJjYmFkNDM2NmIwYzExZTdjIiwiaWF0IjoxNjc4MDc4NDMyLCJleHAiOjE2NzgxMTQ0MzJ9.gzwp_svZlbA5PV_eawYV-9UFjZVjniy-tCDce16xrkI" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Auth"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SignInReq" - }, - "examples": { - "example-1": { - "value": { - "email": "user@example.com", - "password": "Password" - } - } - } - } - } - }, - "description": "Authenticate existing user with their email and password. Successful login will return a JWT access-token. " - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "/api/v1/auth/user/me": { - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "get": { - "summary": "Get User Info", - "operationId": "auth-me", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UserInfo" - }, - "examples": { - "example-1": { - "value": { - "id": "us_8kugj628ebjngs", - "email": "user@example.com", - "email_verified": true, - "firstname": "Alice", - "lastname": "Smith", - "roles": "org-level-viewer" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Auth"], - "description": "Returns authenticated user info", - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id" - }, - "in": "query", - "name": "project_id", - "description": "Pass project id to get project specific roles along with user info" - } - ] - } - }, - "/api/v1/auth/password/forgot": { - "post": { - "summary": "Forget Password", - "operationId": "auth-password-forgot", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "q9s5vh2i34x6c" - }, - "example": "Please check your email to reset the password", - "description": "Success Message" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "Please check your email to reset the password" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Emails user with a reset url.", - "tags": ["Auth"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PasswordForgotReq" - }, - "examples": { - "Example 1": { - "value": { - "email": "user@example.com" - } - } - } - } - }, - "description": "Pass registered user email id in request body" - } - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "/api/v1/auth/password/change": { - "post": { - "summary": "Change Password", - "operationId": "auth-password-change", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "description": "Success Message" - } - } - }, - "examples": { - "Success response": { - "value": { - "msg": "Password has been updated successfully" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Change password of authenticated user with a new one.", - "tags": ["Auth"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PasswordChangeReq" - }, - "examples": { - "example-1": { - "value": { - "currentPassword": "currentPassword", - "newPassword": "newPassword" - } - } - } - } - }, - "description": "Old password need to be passed along with new password for changing password." - } - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "/api/v1/auth/token/validate/{token}": { - "post": { - "summary": "Verify Reset Token", - "operationId": "auth-password-reset-token-validate", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "unxdsok22kg1y" - }, - "example": "Token has been validated successfully", - "description": "Success Message" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "Token has been validated successfully" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Validate password reset url token.", - "tags": ["Auth"], - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "parameters": [ - { - "schema": { - "type": "string", - "format": "uuid", - "example": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11" - }, - "name": "token", - "in": "path", - "required": true, - "description": "Reset Token" - } - ] - }, - "/api/v1/auth/email/validate/{token}": { - "post": { - "summary": "Verify Email", - "operationId": "auth-email-validate", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "u49sbr20s9rgf" - }, - "description": "Success Message", - "example": "Email has been verified successfully" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "Email has been verified successfully" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Api for verifying email where token need to be passed which is shared to user email.", - "tags": ["Auth"], - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "parameters": [ - { - "schema": { - "type": "string", - "format": "uuid", - "example": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11" - }, - "name": "token", - "in": "path", - "required": true, - "description": "Validation Token" - } - ] - }, - "/api/v1/auth/password/reset/{token}": { - "post": { - "summary": "Reset Password", - "operationId": "auth-password-reset", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "2to6ro4121rfx" - }, - "description": "Success Message", - "example": "Password has been reset successfully" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "Password has been reset successfully" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Update user password to new by using reset token.", - "tags": ["Auth"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PasswordResetReq" - }, - "examples": { - "Example 1": { - "value": { - "password": "newpassword" - } - } - } - } - } - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "parameters": [ - { - "schema": { - "type": "string", - "format": "uuid", - "example": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11" - }, - "name": "token", - "in": "path", - "required": true, - "description": "Reset Password Token" - } - ] - }, - "/api/v1/auth/token/refresh": { - "post": { - "summary": "Refresh Token", - "operationId": "auth-token-refresh", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "token": { - "type": "string", - "description": "New access token for user", - "example": "96751db2d53fb834382b682268874a2ea9ee610e4d904e688d1513f11d3c30d62d36d9e05dec0d63" - } - } - }, - "examples": { - "Example 1": { - "value": { - "token": "96751db2d53fb834382b682268874a2ea9ee610e4d904e688d1513f11d3c30d62d36d9e05dec0d63" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Regenerate user refresh token", - "tags": ["Auth"], - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "/api/v1/tokens": { - "get": { - "summary": "List Organisation API Tokens", - "operationId": "org-tokens-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiTokenList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "id": "1", - "fk_user_id": "us_b3xo2i44nx5y9l", - "description": "This API Token is for ABC application", - "token": "DYh540o8hbWpUGdarekECKLdN5OhlgCUWutVJYX2" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "List all organisation API tokens. Access with API tokens will be blocked.", - "tags": ["Org Tokens"], - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "post": { - "summary": "Create Organisation API Token", - "operationId": "org-tokens-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiToken" - }, - "examples": { - "Example 1": { - "value": { - "id": "1", - "fk_user_id": "us_b3xo2i44nx5y9l", - "description": "This API Token is for ABC application", - "token": "DYh540o8hbWpUGdarekECKLdN5OhlgCUWutVJYX2" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiTokenReq" - }, - "examples": { - "Example 1": { - "value": { - "description": "This API token is for ABC application" - } - } - } - } - } - }, - "tags": ["Org Tokens"], - "description": "Creat an organisation API token. Access with API tokens will be blocked." - } - }, - "/api/v1/tokens/{token}": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "token", - "in": "path", - "required": true, - "description": "API Token" - } - ], - "delete": { - "summary": "Delete Organisation API Tokens", - "operationId": "org-tokens-delete", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number", - "example": 1 - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Org Tokens"], - "description": "Delete an organisation API token. Access with API tokens will be blocked.", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/license": { - "get": { - "summary": "Get App License", - "operationId": "org-license-get", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Application license key" - } - } - }, - "examples": { - "Example 1": { - "value": { - "key": "195f7bcc-c3e1-43c5-b23c-8d8127280e7d" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Get the application license key. Exclusive for super admin.", - "tags": ["Org License"], - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "post": { - "summary": "Create App License", - "operationId": "org-license-set", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "wsiywigeb9hjl" - }, - "example": "The license key has been saved" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "The license key has been saved" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/LicenseReq" - }, - "examples": { - "Example 1": { - "value": { - "key": "1234567890" - } - } - } - } - } - }, - "tags": ["Org License"], - "description": "Set the application license key. Exclusive for super admin.", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/app-settings": { - "get": { - "summary": "Get App Settings", - "operationId": "org-app-settings-get", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "invite_only_signup": { - "type": "boolean", - "description": "Status of invite only signup", - "example": true - } - } - }, - "examples": { - "Example 1": { - "value": { - "invite_only_signup": true - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Get the application settings. Exclusive for super admin.", - "tags": ["Org App Settings"], - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "post": { - "summary": "Create App Settings", - "operationId": "org-app-settings-set", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "6qbh8ijtc4tva" - }, - "example": "The app settings have been saved" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "The app settings have been saved" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "invite_only_signup": { - "type": "boolean", - "description": "Status of invite only signup", - "example": true - } - } - }, - "examples": { - "Example 1": { - "value": { - "invite_only_signup": true - } - } - } - } - } - }, - "tags": ["Org App Settings"], - "description": "Update the application settings. Exclusive for super admin.", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/users": { - "get": { - "summary": "List Organisation Users", - "operationId": "org-users-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UserList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "email": "user@example.com", - "email_verified": true, - "firstname": "Alice", - "id": "us_8kugj628ebjngs", - "lastname": "Smith", - "roles": "org-level-viewer" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "List all organisation users. Exclusive for Super Admin. Access with API Tokens will be blocked.", - "tags": ["Org Users"], - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "post": { - "summary": "Create Organisation User", - "operationId": "org-users-add", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "x-examples": { - "Example 1": { - "invite_token": "c22c129f-d947-4030-a838-1b498fce21bb", - "email": "w123@nocodb.com" - } - }, - "properties": { - "invite_token": { - "type": "string", - "description": "Invite Token" - }, - "email": { - "type": "string", - "description": "User email", - "example": "user@example.com" - } - } - }, - "examples": { - "Example 1": { - "value": { - "invite_token": "c22c129f-d947-4030-a838-1b498fce21bb", - "email": "user@example.com" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/OrgUserReq" - }, - "examples": { - "Example 1": { - "value": { - "email": "user@example.com", - "roles": "org-level-creator" - } - } - } - } - } - }, - "tags": ["Org Users"], - "description": "Create an organisation user. Exclusive for Super Admin. Access with API Tokens will be blocked.", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/users/{userId}": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "us_b3xo2i44nx5y9l" - }, - "name": "userId", - "in": "path", - "required": true, - "description": "Unique User ID" - } - ], - "patch": { - "summary": "Update Organisation User", - "operationId": "org-users-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "6oa45bkw7j57j" - }, - "example": "The user has been updated successfully" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "The user has been updated successfully" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Org Users"], - "description": "Update an organisation user by User ID. Exclusive for Super Admin. Access with API Tokens will be blocked.", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/OrgUserReq" - }, - "examples": { - "Example 1": { - "value": { - "email": "user@example.com", - "roles": "org-level-creator" - } - } - } - } - }, - "description": "" - } - }, - "delete": { - "summary": "Delete Organisation User", - "operationId": "org-users-delete", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "buvrqjvv255tf" - }, - "example": "The user has been deleted successfully", - "description": "Sucess Message" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "The user has been deleted successfully" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Org Users"], - "description": "Delete an organisation user by User ID. Exclusive for Super Admin. Access with API Tokens will be blocked." - } - }, - "/api/v1/users/{userId}/resend-invite": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "us_b3xo2i44nx5y9l" - }, - "name": "userId", - "in": "path", - "required": true, - "description": "Unique User ID" - } - ], - "post": { - "summary": "Invite Organisation User", - "operationId": "org-users-resend-invite", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "aixfqd9jfh5pq" - }, - "example": "The invitation has been sent to the target user", - "description": "Success Message" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "The invitation has been sent to the target user" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Org Users"], - "description": "Resend Invitation to a specific user. Exclusive for Super Admin. Access with API Tokens will be blocked.", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/users/{userId}/generate-reset-url": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "us_b3xo2i44nx5y9l" - }, - "name": "userId", - "in": "path", - "required": true, - "description": "Unique User ID" - } - ], - "post": { - "summary": "Generate Organisation User Password Reset Token", - "operationId": "org-users-generate-password-reset-token", - "tags": ["Org Users"], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "reset_password_token": { - "type": "string", - "description": "Password Reset Token for the user" - }, - "reset_password_url": { - "type": "string", - "description": "Password Reset URL for the user" - } - } - }, - "examples": { - "Example 1": { - "value": { - "reset_password_token": "string", - "reset_password_url": "string" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Generate Password Reset Token for Organisation User. Exclusive for Super Admin. Access with API Tokens will be blocked.", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/projects/{projectId}/users": { - "get": { - "summary": "List Project Users", - "operationId": "auth-project-user-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "users": { - "type": "object", - "properties": { - "list": { - "type": "array", - "uniqueItems": true, - "minItems": 1, - "items": { - "$ref": "#/components/schemas/User" - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated" - } - }, - "required": ["list", "pageInfo"] - } - } - }, - "examples": { - "Example 1": { - "value": { - "users": { - "list": [ - { - "email": "user@example.com", - "email_verified": true, - "firstname": "Alice", - "id": "us_8kugj628ebjngs", - "lastname": "Smith", - "roles": "org-level-viewer" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "List all users in the given project.", - "tags": ["Auth"], - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - } - ], - "post": { - "summary": "Create Project User", - "operationId": "auth-project-user-add", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "waau9tvy75zsd" - }, - "description": "Success Message for inviting single email", - "example": "The user has been invited successfully" - }, - "invite_token": { - "type": "string", - "x-stoplight": { - "id": "yx0s35u8ds3p7" - }, - "example": "8354ddba-a769-4d64-8397-eccb2e2b3c06" - }, - "error": { - "type": "array", - "x-stoplight": { - "id": "yhfi6wzhr6zr1" - }, - "items": { - "x-stoplight": { - "id": "ce0hlv3d0f96j" - }, - "type": "object", - "properties": { - "email": { - "type": "string", - "x-stoplight": { - "id": "dgnh01j4lxvl1" - }, - "example": "w@nocodb.com" - }, - "error": { - "type": "string", - "x-stoplight": { - "id": "7dgttqiijg8no" - }, - "example": "" - } - } - } - }, - "email": { - "type": "string", - "x-stoplight": { - "id": "08pqst2q30vot" - }, - "example": "w@nocodb.com" - } - } - }, - "examples": { - "Inviting a user without any errors": { - "value": { - "msg": "The user has been invited successfully" - } - }, - "Inviting a user but invitation email failed to send": { - "value": { - "invite_token": "8354ddba-a769-4d64-8397-eccb2e2b3c06", - "email": "w@nocodb.com" - } - }, - "Inviting multiple users": { - "value": { - "invite_token": "8354ddba-a769-4d64-8397-eccb2e2b3c06", - "error": [ - { - "email": "w@nocodb.com", - "error": "" - } - ] - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProjectUserReq" - }, - "examples": { - "Example 1": { - "value": { - "email": "user@example.com", - "roles": "owner" - } - } - } - } - } - }, - "tags": ["Auth"], - "description": "Create a user and add it to the given project", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/projects/{projectId}/info": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - } - ], - "get": { - "summary": "Get Project info", - "operationId": "project-meta-get", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "Node": { - "type": "string", - "description": "Node version", - "example": "v12.16.1" - }, - "Arch": { - "type": "string", - "description": "Architecture type", - "example": "x64" - }, - "Platform": { - "type": "string", - "description": "Platform type", - "example": "linux" - }, - "Docker": { - "type": "boolean", - "description": "Is docker", - "example": false - }, - "Database": { - "type": "string", - "description": "Database type", - "example": "postgres" - }, - "ProjectOnRootDB": { - "type": "boolean", - "description": "Is project on rootdb", - "example": false - }, - "RootDB": { - "type": "string", - "description": "Root database type", - "example": "postgres" - }, - "PackageVersion": { - "type": "string", - "description": "Package version", - "example": "1.0.0" - } - } - }, - "examples": { - "Example 1": { - "value": { - "Node": "v12.16.1", - "Arch": "x64", - "Platform": "linux", - "Docker": false, - "Database": "postgres", - "ProjectOnRootDB": false, - "RootDB": "postgres", - "PackageVersion": "1.0.0" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Project"], - "description": "Get info such as node version, arch, platform, is docker, rootdb and package version of a given project", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/projects/{projectId}/users/{userId}": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - }, - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "us_b3xo2i44nx5y9l" - }, - "name": "userId", - "in": "path", - "required": true, - "description": "Unique User ID" - } - ], - "patch": { - "summary": "Update Project User", - "operationId": "auth-project-user-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "5a2q8as60daly" - }, - "description": "Success Message", - "example": "The user has been updated successfully" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "The user has been updated successfully" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProjectUserReq" - }, - "examples": { - "Example 1": { - "value": { - "email": "user@example.com", - "roles": "owner" - } - } - } - } - } - }, - "tags": ["Auth"], - "description": "Update a given user in a given project. Exclusive for Super Admin. Access with API Tokens will be blocked.", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "delete": { - "summary": "Delete Project User", - "operationId": "auth-project-user-remove", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "5h7c9lqh5ynve" - }, - "example": "The user has been updated successfully", - "description": "Success Message" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "The user has been updated successfully" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Auth"], - "description": "Delete a given user in a given project. Exclusive for Super Admin. Access with API Tokens will be blocked.", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/projects/{projectId}/visibility-rules": { - "get": { - "summary": "Get UI ACL", - "operationId": "project-model-visibility-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": {} - }, - "examples": { - "Example 1": { - "value": [ - { - "ptn": "nc_09gt___Sheet-1", - "_ptn": "Sheet-1", - "ptype": "table", - "tn": "Sheet-1", - "_tn": "Sheet-1", - "table_meta": null, - "id": "vw_75neroyqdye94k", - "base_id": "ds_eol59jg2l4zwev", - "project_id": "p_63b4q0qengen1x", - "fk_model_id": "md_5mipbdg6ketmv8", - "title": "Sheet-1", - "type": 3, - "is_default": true, - "show_system_fields": null, - "lock_type": "collaborative", - "uuid": "24a6d0bb-e45d-4b1a-bfef-f492d870de9f", - "password": null, - "show": true, - "order": 1, - "created_at": "2023-03-08T10:44:55.253Z", - "updated_at": "2023-03-10T07:18:44.908Z", - "meta": { - "allowCSVDownload": true - }, - "view": { - "fk_view_id": "vw_75neroyqdye94k", - "base_id": "ds_eol59jg2l4zwev", - "project_id": "p_63b4q0qengen1x", - "uuid": null, - "created_at": "2023-03-08T10:44:55.288Z", - "updated_at": "2023-03-08T10:44:55.288Z", - "meta": null, - "row_height": null - }, - "disabled": { - "owner": false, - "creator": false, - "viewer": false, - "editor": false, - "commenter": false, - "guest": false - } - } - ] - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Hide / show views based on user role", - "tags": ["Project"], - "parameters": [ - { - "schema": { - "type": "boolean" - }, - "in": "query", - "name": "includeM2M" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - } - ], - "post": { - "summary": "Create UI ACL", - "operationId": "project-model-visibility-set", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "2txh071wsodys" - }, - "example": "UI ACL has been created successfully" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "UI ACL has been created successfully" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VisibilityRuleReq" - } - } - } - }, - "tags": ["Project"], - "description": "Hide / show views based on user role", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/projects/": { - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "get": { - "summary": "List Projects", - "operationId": "project-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProjectList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "bases": [ - { - "alias": "string", - "config": null, - "created_at": "2023-03-01 14:27:36", - "enabled": true, - "id": "string", - "inflection_column": "camelize", - "inflection_table": "camelize", - "is_meta": true, - "order": 1, - "project_id": "string", - "type": "mysql2", - "updated_at": "2023-03-01 14:27:36" - } - ], - "color": "#24716E", - "created_at": "2023-03-01 14:27:36", - "deleted": true, - "description": "This is my project description", - "id": "p_124hhlkbeasewh", - "is_meta": true, - "meta": {}, - "order": 0, - "prefix": "nc_vm5q__", - "status": "string", - "title": "my-project", - "updated_at": "2023-03-01 14:27:36" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "List all project meta data", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["Project"] - }, - "post": { - "summary": "Create Project", - "operationId": "project-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProjectReq" - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/Project" - }, - { - "type": "object", - "properties": { - "external": { - "type": "boolean", - "default": false, - "description": "If true, the project will us an external database else it will use the root database" - } - } - } - ] - }, - "examples": { - "Example 1": { - "value": { - "bases": [ - { - "alias": "string", - "config": null, - "enabled": true, - "id": "string", - "inflection_column": "camelize", - "inflection_table": "camelize", - "is_meta": true, - "order": 1, - "project_id": "string", - "type": "mysql2", - "updated_at": "2023-03-01 14:27:36" - } - ], - "color": "#24716E", - "created_at": "2023-03-01 14:27:36", - "deleted": true, - "description": "This is my project description", - "id": "p_124hhlkbeasewh", - "is_meta": true, - "meta": {}, - "order": 0, - "prefix": "nc_vm5q__", - "status": "string", - "title": "my-project", - "external": false - } - } - } - } - } - }, - "tags": ["Project"], - "description": "Create a new project", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/projects/{projectId}": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - } - ], - "get": { - "summary": "Get Project", - "operationId": "project-read", - "description": "Get the info of a given project", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["Project"], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Project" - }, - "examples": { - "Example 1": { - "value": { - "bases": [ - { - "alias": "string", - "config": null, - "enabled": true, - "id": "string", - "inflection_column": "camelize", - "inflection_table": "camelize", - "is_meta": true, - "order": 1, - "project_id": "string", - "type": "mysql2", - "updated_at": "2023-03-01 14:27:36" - } - ], - "color": "#24716E", - "created_at": "2023-03-01 14:27:36", - "deleted": true, - "description": "This is my project description", - "id": "p_124hhlkbeasewh", - "is_meta": true, - "meta": {}, - "order": 0, - "prefix": "nc_vm5q__", - "status": "string", - "title": "my-project" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - } - }, - "delete": { - "summary": "Delete Project", - "operationId": "project-delete", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "boolean" - }, - "examples": { - "Example 1": { - "value": true - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Project"], - "description": "Delete the given project", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "patch": { - "summary": "Update Project", - "operationId": "project-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number", - "example": 1 - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Project"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProjectUpdateReq" - }, - "examples": { - "Example 1": { - "value": { - "color": "#24716E", - "meta": null, - "title": "My Project" - } - } - } - } - } - }, - "description": "Update the given project", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/projects/{projectId}/bases/{baseId}": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - }, - { - "schema": { - "type": "string", - "pattern": "ds_j04jmxh5xg10lu" - }, - "name": "baseId", - "in": "path", - "required": true, - "description": "Unique Base ID" - } - ], - "get": { - "summary": "Get Base", - "operationId": "base-read", - "description": "Get the base details of a given project", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["Base"], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Base" - }, - "examples": { - "Example 1": { - "value": { - "alias": null, - "config": "", - "enabled": 1, - "id": "ds_krsappzu9f8vmo", - "inflection_column": "camelize", - "inflection_table": "camelize", - "is_meta": 1, - "meta": null, - "order": 1, - "project_id": "p_01clqvzik3izk6", - "type": "mysql2" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - } - }, - "delete": { - "summary": "Delete Base", - "operationId": "base-delete", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "boolean" - }, - "examples": { - "Example 1": { - "value": true - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Base"], - "description": "Delete the base details of a given project", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "patch": { - "summary": "Update Base", - "operationId": "base-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {} - }, - "examples": { - "Example 1": { - "value": { - "id": "ds_rrplkgy0pq1f3c", - "project_id": "p_63b4q0qengen1x", - "alias": "sakila", - "meta": null, - "is_meta": null, - "type": "mysql2", - "inflection_column": "camelize", - "inflection_table": "camelize", - "created_at": "2023-03-11T10:31:15.341Z", - "updated_at": "2023-03-11T10:32:25.763Z", - "enabled": true, - "order": 2 - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Base"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "examples": { - "Example 1": { - "value": { - "alias": "sakila", - "type": "mysql2", - "config": { - "client": "mysql2", - "connection": { - "host": "localhost", - "port": "3306", - "user": "root", - "password": "password", - "database": "sakila" - } - }, - "inflection_column": "camelize", - "inflection_table": "camelize" - } - } - } - } - } - }, - "description": "Update the base details of a given project", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/projects/{projectId}/bases/": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - } - ], - "get": { - "summary": "List Bases", - "operationId": "base-list", - "description": "Get project base list", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["Base"], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BaseList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "alias": null, - "config": "", - "enabled": 1, - "id": "ds_krsappzu9f8vmo", - "inflection_column": "camelize", - "inflection_table": "camelize", - "is_meta": 1, - "meta": null, - "order": 1, - "project_id": "p_01clqvzik3izk6", - "type": "mysql2" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - } - }, - "post": { - "summary": "Create Base", - "operationId": "base-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Base" - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/Base" - }, - { - "type": "object", - "properties": { - "external": { - "type": "boolean", - "default": false - } - } - } - ] - }, - "examples": { - "Example 1": { - "value": { - "alias": null, - "config": "", - "enabled": 1, - "id": "ds_krsappzu9f8vmo", - "inflection_column": "camelize", - "inflection_table": "camelize", - "is_meta": 1, - "meta": null, - "order": 1, - "project_id": "p_01clqvzik3izk6", - "type": "mysql2", - "external": false - } - } - } - } - } - }, - "tags": ["Base"], - "description": "Create a new base on a given project", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/projects/{projectId}/shared": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - } - ], - "get": { - "summary": "Get Project Shared Base", - "operationId": "project-shared-base-get", - "description": "Get Project Shared Base", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["Project"], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "uuid": { - "type": "string", - "format": "uuid", - "example": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11" - }, - "url": { - "type": "string", - "format": "uri" - }, - "roles": { - "type": "string", - "example": "viewer" - } - } - }, - "examples": { - "Example 1": { - "value": { - "uuid": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11", - "url": "http://example.com", - "roles": "viewer" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - } - }, - "delete": { - "summary": "Delete Project Shared Base", - "operationId": "project-shared-base-disable", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "boolean" - }, - "examples": { - "Example 1": { - "value": true - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Project"], - "description": "Delete Project Shared Base", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "post": { - "summary": "Create Project Shared Base", - "operationId": "project-shared-base-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "uuid": { - "$ref": "#/components/schemas/StringOrNull" - }, - "roles": { - "$ref": "#/components/schemas/StringOrNull" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Project"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SharedBaseReq" - }, - "examples": { - "Example 1": { - "value": { - "roles": "editor", - "password": "password123" - } - } - } - } - } - }, - "description": "Create Project Shared Base", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "patch": { - "summary": "Update Project Shared Base", - "operationId": "project-shared-base-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "uuid": { - "type": "string", - "format": "uuid", - "example": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11" - }, - "url": { - "type": "string", - "format": "uri" - }, - "roles": { - "type": "string", - "example": "viewer" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SharedBaseReq" - }, - "examples": { - "Example 1": { - "value": { - "password": "password123", - "roles": "editor" - } - } - } - } - } - }, - "tags": ["Project"], - "description": "Update Project Shared Base", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/projects/{projectId}/cost": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - } - ], - "get": { - "summary": "Project Cost", - "operationId": "project-cost", - "description": "Calculate the Project Cost", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["Project"], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {} - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "x-internal": true - } - }, - "/api/v1/db/meta/projects/{projectId}/tables": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - } - ], - "post": { - "summary": "Create Table", - "operationId": "db-table-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Table" - }, - "examples": { - "Example 1": { - "value": { - "base_id": "ds_g4ccx6e77h1dmi", - "columns": [ - { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": "CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP", - "clen": null, - "column_name": "updated_at", - "cop": "4", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "timestamp", - "deleted": null, - "dt": "timestamp", - "dtx": "specificType", - "dtxp": "0", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_m4wkaqgqqjzoeh", - "meta": null, - "np": null, - "ns": null, - "order": 4, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 0, - "system": 0, - "title": "UpdatedAt", - "uidt": "DateTime", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": "CURRENT_TIMESTAMP", - "clen": null, - "column_name": "created_at", - "cop": "3", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "timestamp", - "deleted": null, - "dt": "timestamp", - "dtx": "specificType", - "dtxp": "0", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_jpl0qu4gj4rexq", - "meta": null, - "np": null, - "ns": null, - "order": 3, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 0, - "system": 0, - "title": "CreatedAt", - "uidt": "DateTime", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": null, - "clen": "45", - "column_name": "title", - "cop": "2", - "created_at": "2023-03-02 17:04:06", - "csn": "utf8mb4", - "ct": "varchar(45)", - "deleted": null, - "dt": "varchar", - "dtx": "specificType", - "dtxp": "45", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_c5knoi4xs4sfpt", - "meta": null, - "np": null, - "ns": null, - "order": 2, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": 1, - "rqd": 0, - "system": 0, - "title": "Title", - "uidt": "SingleLineText", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - { - "ai": 1, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": null, - "clen": null, - "column_name": "id", - "cop": "1", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "int unsigned", - "deleted": null, - "dt": "int", - "dtx": "specificType", - "dtxp": "", - "dtxs": "0", - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_phvuuwjrzcdo0g", - "meta": null, - "np": "10", - "ns": "0", - "order": 1, - "pk": 1, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 1, - "system": 0, - "title": "Id", - "uidt": "ID", - "un": 1, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - } - ], - "columnsById": { - "cl_c5knoi4xs4sfpt": { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": null, - "clen": "45", - "column_name": "title", - "cop": "2", - "created_at": "2023-03-02 17:04:06", - "csn": "utf8mb4", - "ct": "varchar(45)", - "deleted": null, - "dt": "varchar", - "dtx": "specificType", - "dtxp": "45", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_c5knoi4xs4sfpt", - "meta": null, - "np": null, - "ns": null, - "order": 2, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": 1, - "rqd": 0, - "system": 0, - "title": "Title", - "uidt": "SingleLineText", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - "cl_jpl0qu4gj4rexq": { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": "CURRENT_TIMESTAMP", - "clen": null, - "column_name": "created_at", - "cop": "3", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "timestamp", - "deleted": null, - "dt": "timestamp", - "dtx": "specificType", - "dtxp": "0", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_jpl0qu4gj4rexq", - "meta": null, - "np": null, - "ns": null, - "order": 3, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 0, - "system": 0, - "title": "CreatedAt", - "uidt": "DateTime", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - "cl_m4wkaqgqqjzoeh": { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": "CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP", - "clen": null, - "column_name": "updated_at", - "cop": "4", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "timestamp", - "deleted": null, - "dt": "timestamp", - "dtx": "specificType", - "dtxp": "0", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_m4wkaqgqqjzoeh", - "meta": null, - "np": null, - "ns": null, - "order": 4, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 0, - "system": 0, - "title": "UpdatedAt", - "uidt": "DateTime", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - "cl_phvuuwjrzcdo0g": { - "ai": 1, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": null, - "clen": null, - "column_name": "id", - "cop": "1", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "int unsigned", - "deleted": null, - "dt": "int", - "dtx": "specificType", - "dtxp": "", - "dtxs": "0", - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_phvuuwjrzcdo0g", - "meta": null, - "np": "10", - "ns": "0", - "order": 1, - "pk": 1, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 1, - "system": 0, - "title": "Id", - "uidt": "ID", - "un": 1, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - } - }, - "created_at": "2023-03-02 17:04:06", - "deleted": null, - "enabled": 1, - "id": "md_rsu68aqjsbyqtl", - "meta": null, - "mm": 0, - "order": 1, - "pinned": null, - "project_id": "p_xm3thidrblw4n7", - "schema": null, - "table_name": "nc_vm5q___Table1", - "tags": null, - "title": "Table1", - "type": "table", - "updated_at": "2023-03-02 17:04:08", - "views": [ - { - "_ptn": "Table1", - "_tn": "Table1", - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:04:06", - "disabled": { - "commenter": false, - "creator": false, - "editor": false, - "guest": false, - "owner": false, - "viewer": false - }, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "vw_p2jcatxz4mvcfw", - "is_default": 1, - "lock_type": "collaborative", - "meta": {}, - "order": 1, - "password": null, - "project_id": "p_xm3thidrblw4n7", - "ptn": "nc_vm5q___Table1", - "ptype": "table", - "show": 1, - "show_system_fields": null, - "table_meta": null, - "title": "Table1", - "tn": "Table1", - "type": 3, - "updated_at": "2023-03-02 17:04:06", - "uuid": null, - "view": { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:04:06", - "fk_view_id": "vw_p2jcatxz4mvcfw", - "meta": null, - "project_id": "p_xm3thidrblw4n7", - "row_height": null, - "updated_at": "2023-03-02 17:04:06", - "uuid": null - } - } - ] - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TableReq" - } - } - } - }, - "tags": ["DB Table"], - "description": "Create a new table in a given project", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "get": { - "summary": "List Tables", - "operationId": "db-table-list", - "responses": { - "200": { - "$ref": "#/components/responses/TableList" - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - }, - { - "schema": { - "type": "number" - }, - "in": "query", - "name": "page" - }, - { - "schema": { - "type": "number" - }, - "in": "query", - "name": "pageSize" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "sort" - }, - { - "schema": { - "type": "boolean" - }, - "in": "query", - "name": "includeM2M" - } - ], - "tags": ["DB Table"], - "description": "List all tables in a given project" - } - }, - "/api/v1/db/meta/tables/{tableId}": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "md_w9gpnaousnfss1", - "type": "string" - }, - "name": "tableId", - "in": "path", - "required": true, - "description": "Unique Table ID" - } - ], - "get": { - "summary": "Read Table", - "operationId": "db-table-read", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Table" - }, - "examples": { - "Example 1": { - "value": { - "id": "md_rsu68aqjsbyqtl", - "base_id": "ds_g4ccx6e77h1dmi", - "project_id": "p_xm3thidrblw4n7", - "table_name": "nc_vm5q___Table1", - "title": "Table1", - "type": "table", - "meta": null, - "schema": null, - "enabled": 1, - "mm": 0, - "tags": null, - "pinned": null, - "deleted": null, - "order": 1, - "created_at": "2023-03-02 17:04:06", - "updated_at": "2023-03-02 17:04:08", - "columns": [ - { - "id": "cl_phvuuwjrzcdo0g", - "base_id": "ds_g4ccx6e77h1dmi", - "project_id": "p_xm3thidrblw4n7", - "fk_model_id": "md_rsu68aqjsbyqtl", - "title": "Id", - "column_name": "id", - "uidt": "ID", - "dt": "int", - "np": "10", - "ns": "0", - "clen": null, - "cop": "1", - "pk": 1, - "pv": null, - "rqd": 1, - "un": 1, - "ct": "int unsigned", - "ai": 1, - "unique": 0, - "cdf": null, - "cc": "", - "csn": null, - "dtx": "specificType", - "dtxp": "", - "dtxs": "0", - "au": 0, - "validate": null, - "virtual": null, - "deleted": null, - "system": 0, - "order": 1, - "created_at": "2023-03-02 17:04:06", - "updated_at": "2023-03-02 17:04:06", - "meta": null - }, - { - "id": "cl_c5knoi4xs4sfpt", - "base_id": "ds_g4ccx6e77h1dmi", - "project_id": "p_xm3thidrblw4n7", - "fk_model_id": "md_rsu68aqjsbyqtl", - "title": "Title", - "column_name": "title", - "uidt": "SingleLineText", - "dt": "varchar", - "np": null, - "ns": null, - "clen": "45", - "cop": "2", - "pk": 0, - "pv": 1, - "rqd": 0, - "un": 0, - "ct": "varchar(45)", - "ai": 0, - "unique": 0, - "cdf": null, - "cc": "", - "csn": "utf8mb4", - "dtx": "specificType", - "dtxp": "45", - "dtxs": null, - "au": 0, - "validate": null, - "virtual": null, - "deleted": null, - "system": 0, - "order": 2, - "created_at": "2023-03-02 17:04:06", - "updated_at": "2023-03-02 17:04:06", - "meta": null - }, - { - "id": "cl_jpl0qu4gj4rexq", - "base_id": "ds_g4ccx6e77h1dmi", - "project_id": "p_xm3thidrblw4n7", - "fk_model_id": "md_rsu68aqjsbyqtl", - "title": "CreatedAt", - "column_name": "created_at", - "uidt": "DateTime", - "dt": "timestamp", - "np": null, - "ns": null, - "clen": null, - "cop": "3", - "pk": 0, - "pv": null, - "rqd": 0, - "un": 0, - "ct": "timestamp", - "ai": 0, - "unique": 0, - "cdf": "CURRENT_TIMESTAMP", - "cc": "", - "csn": null, - "dtx": "specificType", - "dtxp": "0", - "dtxs": null, - "au": 0, - "validate": null, - "virtual": null, - "deleted": null, - "system": 0, - "order": 3, - "created_at": "2023-03-02 17:04:06", - "updated_at": "2023-03-02 17:04:06", - "meta": null - }, - { - "id": "cl_m4wkaqgqqjzoeh", - "base_id": "ds_g4ccx6e77h1dmi", - "project_id": "p_xm3thidrblw4n7", - "fk_model_id": "md_rsu68aqjsbyqtl", - "title": "UpdatedAt", - "column_name": "updated_at", - "uidt": "DateTime", - "dt": "timestamp", - "np": null, - "ns": null, - "clen": null, - "cop": "4", - "pk": 0, - "pv": null, - "rqd": 0, - "un": 0, - "ct": "timestamp", - "ai": 0, - "unique": 0, - "cdf": "CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP", - "cc": "", - "csn": null, - "dtx": "specificType", - "dtxp": "0", - "dtxs": null, - "au": 0, - "validate": null, - "virtual": null, - "deleted": null, - "system": 0, - "order": 4, - "created_at": "2023-03-02 17:04:06", - "updated_at": "2023-03-02 17:04:06", - "meta": null - } - ], - "views": [ - { - "ptn": "nc_vm5q___Table1", - "_ptn": "Table1", - "ptype": "table", - "tn": "Table1", - "_tn": "Table1", - "table_meta": null, - "id": "vw_p2jcatxz4mvcfw", - "base_id": "ds_g4ccx6e77h1dmi", - "project_id": "p_xm3thidrblw4n7", - "fk_model_id": "md_rsu68aqjsbyqtl", - "title": "Table1", - "type": 3, - "is_default": 1, - "show_system_fields": null, - "lock_type": "collaborative", - "uuid": null, - "password": null, - "show": 1, - "order": 1, - "created_at": "2023-03-02 17:04:06", - "updated_at": "2023-03-02 17:04:06", - "meta": {}, - "view": { - "fk_view_id": "vw_p2jcatxz4mvcfw", - "base_id": "ds_g4ccx6e77h1dmi", - "project_id": "p_xm3thidrblw4n7", - "uuid": null, - "created_at": "2023-03-02 17:04:06", - "updated_at": "2023-03-02 17:04:06", - "meta": null, - "row_height": null - }, - "disabled": { - "owner": false, - "creator": false, - "viewer": false, - "editor": false, - "commenter": false, - "guest": false - } - } - ], - "columnsById": { - "cl_phvuuwjrzcdo0g": { - "id": "cl_phvuuwjrzcdo0g", - "base_id": "ds_g4ccx6e77h1dmi", - "project_id": "p_xm3thidrblw4n7", - "fk_model_id": "md_rsu68aqjsbyqtl", - "title": "Id", - "column_name": "id", - "uidt": "ID", - "dt": "int", - "np": "10", - "ns": "0", - "clen": null, - "cop": "1", - "pk": 1, - "pv": null, - "rqd": 1, - "un": 1, - "ct": "int unsigned", - "ai": 1, - "unique": 0, - "cdf": null, - "cc": "", - "csn": null, - "dtx": "specificType", - "dtxp": "", - "dtxs": "0", - "au": 0, - "validate": null, - "virtual": null, - "deleted": null, - "system": 0, - "order": 1, - "created_at": "2023-03-02 17:04:06", - "updated_at": "2023-03-02 17:04:06", - "meta": null - }, - "cl_c5knoi4xs4sfpt": { - "id": "cl_c5knoi4xs4sfpt", - "base_id": "ds_g4ccx6e77h1dmi", - "project_id": "p_xm3thidrblw4n7", - "fk_model_id": "md_rsu68aqjsbyqtl", - "title": "Title", - "column_name": "title", - "uidt": "SingleLineText", - "dt": "varchar", - "np": null, - "ns": null, - "clen": "45", - "cop": "2", - "pk": 0, - "pv": 1, - "rqd": 0, - "un": 0, - "ct": "varchar(45)", - "ai": 0, - "unique": 0, - "cdf": null, - "cc": "", - "csn": "utf8mb4", - "dtx": "specificType", - "dtxp": "45", - "dtxs": null, - "au": 0, - "validate": null, - "virtual": null, - "deleted": null, - "system": 0, - "order": 2, - "created_at": "2023-03-02 17:04:06", - "updated_at": "2023-03-02 17:04:06", - "meta": null - }, - "cl_jpl0qu4gj4rexq": { - "id": "cl_jpl0qu4gj4rexq", - "base_id": "ds_g4ccx6e77h1dmi", - "project_id": "p_xm3thidrblw4n7", - "fk_model_id": "md_rsu68aqjsbyqtl", - "title": "CreatedAt", - "column_name": "created_at", - "uidt": "DateTime", - "dt": "timestamp", - "np": null, - "ns": null, - "clen": null, - "cop": "3", - "pk": 0, - "pv": null, - "rqd": 0, - "un": 0, - "ct": "timestamp", - "ai": 0, - "unique": 0, - "cdf": "CURRENT_TIMESTAMP", - "cc": "", - "csn": null, - "dtx": "specificType", - "dtxp": "0", - "dtxs": null, - "au": 0, - "validate": null, - "virtual": null, - "deleted": null, - "system": 0, - "order": 3, - "created_at": "2023-03-02 17:04:06", - "updated_at": "2023-03-02 17:04:06", - "meta": null - }, - "cl_m4wkaqgqqjzoeh": { - "id": "cl_m4wkaqgqqjzoeh", - "base_id": "ds_g4ccx6e77h1dmi", - "project_id": "p_xm3thidrblw4n7", - "fk_model_id": "md_rsu68aqjsbyqtl", - "title": "UpdatedAt", - "column_name": "updated_at", - "uidt": "DateTime", - "dt": "timestamp", - "np": null, - "ns": null, - "clen": null, - "cop": "4", - "pk": 0, - "pv": null, - "rqd": 0, - "un": 0, - "ct": "timestamp", - "ai": 0, - "unique": 0, - "cdf": "CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP", - "cc": "", - "csn": null, - "dtx": "specificType", - "dtxp": "0", - "dtxs": null, - "au": 0, - "validate": null, - "virtual": null, - "deleted": null, - "system": 0, - "order": 4, - "created_at": "2023-03-02 17:04:06", - "updated_at": "2023-03-02 17:04:06", - "meta": null - } - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table"], - "description": "Read the table meta data by the given table ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "patch": { - "summary": "Update Table", - "operationId": "db-table-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "5a0g9yvs4e678" - }, - "example": "The table has been updated successfully" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "The table has been updated successfully" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "table_name": { - "type": "string", - "description": "Table name", - "example": "users" - }, - "title": { - "type": "string", - "description": "Table title", - "example": "Users" - }, - "project_id": { - "type": "string", - "description": "Project ID", - "example": "p_124hhlkbeasewh" - }, - "meta": { - "$ref": "#/components/schemas/Meta" - } - } - }, - "examples": { - "Example 1": { - "value": { - "table_name": "users", - "title": "Users", - "project_id": "p_124hhlkbeasewh", - "meta": null - } - } - } - } - } - }, - "description": "Update the table meta data by the given table ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "delete": { - "summary": "Delete Table", - "operationId": "db-table-delete", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "boolean" - }, - "examples": { - "Example 1": { - "value": true - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table"], - "description": "Delete the table meta data by the given table ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/projects/{projectId}/{baseId}/tables": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - }, - { - "schema": { - "type": "string", - "pattern": "ds_j04jmxh5xg10lu" - }, - "name": "baseId", - "in": "path", - "required": true, - "description": "Unique Base ID" - } - ], - "get": { - "summary": "List Tables", - "operationId": "table-list", - "responses": { - "200": { - "$ref": "#/components/responses/TableList" - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - }, - { - "schema": { - "type": "number" - }, - "in": "query", - "name": "page" - }, - { - "schema": { - "type": "number" - }, - "in": "query", - "name": "pageSize" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "sort" - }, - { - "schema": { - "type": "boolean" - }, - "in": "query", - "name": "includeM2M" - } - ], - "tags": ["Base"], - "description": "List all tables in a given Project and Base" - }, - "post": { - "summary": "Create Table", - "operationId": "table-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Table" - }, - "examples": { - "Example 1": { - "value": { - "base_id": "ds_g4ccx6e77h1dmi", - "columns": [ - { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": "CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP", - "clen": null, - "column_name": "updated_at", - "cop": "4", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "timestamp", - "deleted": null, - "dt": "timestamp", - "dtx": "specificType", - "dtxp": "0", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_m4wkaqgqqjzoeh", - "meta": null, - "np": null, - "ns": null, - "order": 4, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 0, - "system": 0, - "title": "UpdatedAt", - "uidt": "DateTime", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": "CURRENT_TIMESTAMP", - "clen": null, - "column_name": "created_at", - "cop": "3", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "timestamp", - "deleted": null, - "dt": "timestamp", - "dtx": "specificType", - "dtxp": "0", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_jpl0qu4gj4rexq", - "meta": null, - "np": null, - "ns": null, - "order": 3, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 0, - "system": 0, - "title": "CreatedAt", - "uidt": "DateTime", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": null, - "clen": "45", - "column_name": "title", - "cop": "2", - "created_at": "2023-03-02 17:04:06", - "csn": "utf8mb4", - "ct": "varchar(45)", - "deleted": null, - "dt": "varchar", - "dtx": "specificType", - "dtxp": "45", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_c5knoi4xs4sfpt", - "meta": null, - "np": null, - "ns": null, - "order": 2, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": 1, - "rqd": 0, - "system": 0, - "title": "Title", - "uidt": "SingleLineText", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - { - "ai": 1, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": null, - "clen": null, - "column_name": "id", - "cop": "1", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "int unsigned", - "deleted": null, - "dt": "int", - "dtx": "specificType", - "dtxp": "", - "dtxs": "0", - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_phvuuwjrzcdo0g", - "meta": null, - "np": "10", - "ns": "0", - "order": 1, - "pk": 1, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 1, - "system": 0, - "title": "Id", - "uidt": "ID", - "un": 1, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - } - ], - "columnsById": { - "cl_c5knoi4xs4sfpt": { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": null, - "clen": "45", - "column_name": "title", - "cop": "2", - "created_at": "2023-03-02 17:04:06", - "csn": "utf8mb4", - "ct": "varchar(45)", - "deleted": null, - "dt": "varchar", - "dtx": "specificType", - "dtxp": "45", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_c5knoi4xs4sfpt", - "meta": null, - "np": null, - "ns": null, - "order": 2, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": 1, - "rqd": 0, - "system": 0, - "title": "Title", - "uidt": "SingleLineText", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - "cl_jpl0qu4gj4rexq": { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": "CURRENT_TIMESTAMP", - "clen": null, - "column_name": "created_at", - "cop": "3", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "timestamp", - "deleted": null, - "dt": "timestamp", - "dtx": "specificType", - "dtxp": "0", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_jpl0qu4gj4rexq", - "meta": null, - "np": null, - "ns": null, - "order": 3, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 0, - "system": 0, - "title": "CreatedAt", - "uidt": "DateTime", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - "cl_m4wkaqgqqjzoeh": { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": "CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP", - "clen": null, - "column_name": "updated_at", - "cop": "4", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "timestamp", - "deleted": null, - "dt": "timestamp", - "dtx": "specificType", - "dtxp": "0", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_m4wkaqgqqjzoeh", - "meta": null, - "np": null, - "ns": null, - "order": 4, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 0, - "system": 0, - "title": "UpdatedAt", - "uidt": "DateTime", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - "cl_phvuuwjrzcdo0g": { - "ai": 1, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": null, - "clen": null, - "column_name": "id", - "cop": "1", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "int unsigned", - "deleted": null, - "dt": "int", - "dtx": "specificType", - "dtxp": "", - "dtxs": "0", - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_phvuuwjrzcdo0g", - "meta": null, - "np": "10", - "ns": "0", - "order": 1, - "pk": 1, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 1, - "system": 0, - "title": "Id", - "uidt": "ID", - "un": 1, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - } - }, - "created_at": "2023-03-02 17:04:06", - "deleted": null, - "enabled": 1, - "id": "md_rsu68aqjsbyqtl", - "meta": null, - "mm": 0, - "order": 1, - "pinned": null, - "project_id": "p_xm3thidrblw4n7", - "schema": null, - "table_name": "nc_vm5q___Table1", - "tags": null, - "title": "Table1", - "type": "table", - "updated_at": "2023-03-02 17:04:08", - "views": [ - { - "_ptn": "Table1", - "_tn": "Table1", - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:04:06", - "disabled": { - "commenter": false, - "creator": false, - "editor": false, - "guest": false, - "owner": false, - "viewer": false - }, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "vw_p2jcatxz4mvcfw", - "is_default": 1, - "lock_type": "collaborative", - "meta": {}, - "order": 1, - "password": null, - "project_id": "p_xm3thidrblw4n7", - "ptn": "nc_vm5q___Table1", - "ptype": "table", - "show": 1, - "show_system_fields": null, - "table_meta": null, - "title": "Table1", - "tn": "Table1", - "type": 3, - "updated_at": "2023-03-02 17:04:06", - "uuid": null, - "view": { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:04:06", - "fk_view_id": "vw_p2jcatxz4mvcfw", - "meta": null, - "project_id": "p_xm3thidrblw4n7", - "row_height": null, - "updated_at": "2023-03-02 17:04:06", - "uuid": null - } - } - ] - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TableReq" - }, - "examples": { - "Example 1": { - "value": { - "columns": [ - { - "ai": false, - "altered": 1, - "cdf": "CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP", - "ck": false, - "clen": 45, - "column_name": "updated_at", - "ct": "varchar(45)", - "dt": "timestamp", - "dtx": "specificType", - "dtxp": "", - "dtxs": "", - "np": null, - "nrqd": true, - "ns": null, - "pk": false, - "rqd": false, - "title": "UpdatedAt", - "uicn": "", - "uidt": "DateTime", - "uip": "", - "un": false - }, - { - "ai": false, - "altered": 1, - "cdf": "CURRENT_TIMESTAMP", - "ck": false, - "clen": 45, - "column_name": "created_at", - "ct": "varchar(45)", - "dt": "timestamp", - "dtx": "specificType", - "dtxp": "", - "dtxs": "", - "np": null, - "nrqd": true, - "ns": null, - "pk": false, - "rqd": false, - "title": "CreatedAt", - "uicn": "", - "uidt": "DateTime", - "uip": "", - "un": false - }, - { - "ai": false, - "altered": 1, - "cdf": null, - "ck": false, - "clen": 45, - "column_name": "title", - "ct": "varchar(45)", - "dt": "varchar", - "dtx": "specificType", - "dtxp": "45", - "dtxs": "", - "np": null, - "nrqd": true, - "ns": null, - "pk": false, - "rqd": false, - "title": "Title", - "uicn": "", - "uidt": "SingleLineText", - "uip": "", - "un": false - }, - { - "ai": true, - "altered": 1, - "cdf": null, - "ck": false, - "clen": null, - "column_name": "id", - "ct": "int(11)", - "dt": "int", - "dtx": "integer", - "dtxp": "11", - "dtxs": "", - "np": 11, - "nrqd": false, - "ns": 0, - "pk": true, - "rqd": true, - "title": "Id", - "uicn": "", - "uidt": "ID", - "uip": "", - "un": true - } - ], - "table_name": "Sheet-1", - "title": "Sheet-1" - } - } - } - } - } - }, - "tags": ["Base"], - "description": "Create a new table in a given Project and Base", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/tables/{tableId}/reorder": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "md_w9gpnaousnfss1", - "type": "string" - }, - "name": "tableId", - "in": "path", - "required": true, - "description": "Unique Table ID" - } - ], - "post": { - "summary": "Reorder Table", - "operationId": "db-table-reorder", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "boolean" - }, - "examples": { - "Example 1": { - "value": true - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "order": { - "type": "number" - } - } - }, - "examples": { - "Example 1": { - "value": { - "order": 0 - } - } - } - } - } - }, - "tags": ["DB Table"], - "description": "Update the order of the given Table", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/tables/{tableId}/columns": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "md_w9gpnaousnfss1", - "type": "string" - }, - "name": "tableId", - "in": "path", - "required": true, - "description": "Unique Table ID" - } - ], - "post": { - "summary": "Create Column", - "operationId": "db-table-column-create", - "responses": { - "200": { - "description": "OK" - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ColumnReq" - }, - "examples": { - "Example 1": { - "value": { - "ai": 0, - "au": 0, - "base_id": "ds_krsappzu9f8vmo", - "cc": "", - "cdf": null, - "clen": "45", - "column_name": "title", - "cop": "2", - "csn": "utf8mb4", - "ct": "varchar(45)", - "deleted": null, - "dt": "varchar", - "dtx": "specificType", - "dtxp": "45", - "dtxs": null, - "fk_model_id": "md_yvwvbt2i78rgcm", - "id": "cl_0j9gv0oi8vjy46", - "meta": null, - "np": null, - "ns": null, - "order": 2, - "pk": 0, - "project_id": "p_01clqvzik3izk6", - "pv": 1, - "rqd": 0, - "system": 0, - "title": "Title", - "uidt": "SingleLineText", - "un": 0, - "unique": 0, - "validate": null, - "virtual": null - } - } - } - } - } - }, - "tags": ["DB Table Column"], - "description": "Create a new column in a given Table", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/columns/{columnId}": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "columnId", - "in": "path", - "required": true - } - ], - "patch": { - "summary": "Update Column", - "operationId": "db-table-column-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Column" - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ColumnReq" - } - } - } - }, - "tags": ["DB Table Column"], - "description": "Update the existing column by the given column ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "delete": { - "summary": "Delete Column", - "operationId": "db-table-column-delete", - "responses": { - "200": { - "description": "OK" - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Column"], - "description": "Delete the existing column by the given column ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "get": { - "summary": "Get Column", - "operationId": "db-table-column-get", - "responses": { - "200": { - "description": "OK" - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Column"], - "description": "Get the existing column by the given column ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/columns/{columnId}/primary": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "columnId", - "in": "path", - "required": true - } - ], - "post": { - "summary": "Create Primary Value", - "operationId": "db-table-column-primary-column-set", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "boolean" - }, - "examples": { - "Example 1": { - "value": true - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Column"], - "description": "Set a primary value on a given column", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/tables/{tableId}/views": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "md_w9gpnaousnfss1", - "type": "string" - }, - "name": "tableId", - "in": "path", - "required": true, - "description": "Unique Table ID" - } - ], - "get": { - "summary": "List Views", - "operationId": "db-view-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ViewList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "alias": "string", - "column": [ - { - "alias": "string", - "auto_increment": true, - "auto_update_timestamp": true, - "base_id": "string", - "character_maximum_length": "string", - "character_set_name": "string", - "colOptions": { - "deleted": "string", - "dr": "string", - "fk_child_column_id": "string", - "fk_column_id": "string", - "fk_index_name": "string", - "fk_mm_child_column_id": "string", - "fk_mm_model_id": "string", - "fk_mm_parent_column_id": "string", - "fk_parent_column_id": "string", - "id": "string", - "order": "string", - "type": "string", - "ur": "string", - "virtual": true - }, - "column_comment": "string", - "column_default": "string", - "column_ordinal_position": "string", - "column_type": "string", - "data_type": "string", - "data_type_x": "string", - "data_type_x_precision": "string", - "data_type_x_scale": "string", - "deleted": true, - "fk_model_id": "string", - "id": "string", - "numeric_precision": "string", - "numeric_scale": "string", - "order": 0, - "primary_key": true, - "primary_value": true, - "rqd": "string", - "title": "string", - "ui_data_type": "string", - "un": "string", - "unique": true, - "visible": true - } - ], - "columnByIds": {}, - "deleted": true, - "enabled": true, - "fk_base_id": "string", - "fk_project_id": "string", - "id": "string", - "order": 0, - "parent_id": "string", - "pinned": true, - "show_as": "string", - "tags": "string", - "title": "string", - "type": "string" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "description": "List all views in a given Table.", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/views/{viewId}": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "vw_wtdg2meyig5l4q" - }, - "name": "viewId", - "in": "path", - "required": true, - "description": "Unique View ID" - } - ], - "patch": { - "summary": "Update View", - "operationId": "db-view-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/View" - }, - "examples": { - "Example 1": { - "value": { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:46:31", - "fk_model_id": "md_mhs9z4r2ak98x0", - "id": "vw_lg052cnc1c26kf", - "is_default": 1, - "lock_type": "collaborative", - "meta": "{\"allowCSVDownload\":true}", - "order": 1, - "password": "password123", - "project_id": "p_xm3thidrblw4n7", - "show": 1, - "show_system_fields": null, - "title": "Grid View 1", - "type": 3, - "updated_at": "2023-03-02 17:46:31", - "uuid": null - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ViewUpdateReq" - }, - "examples": { - "Example 1": { - "value": { - "title": "Grid View 1", - "uuid": "e2457bbf-e29c-4fec-866e-fe3b01dba57f", - "password": "password123", - "lock_type": "collaborative", - "meta": "{\"allowCSVDownload\":true}", - "order": 1, - "show_system_fields": 0 - } - } - } - } - } - }, - "tags": ["DB View"], - "description": "Update the view with the given view Id.", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "delete": { - "summary": "Delete View", - "operationId": "db-view-delete", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "boolean" - }, - "examples": { - "Example 1": { - "value": true - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "description": "Delete the view with the given view Id.", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/views/{viewId}/show-all": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "vw_wtdg2meyig5l4q" - }, - "name": "viewId", - "in": "path", - "required": true, - "description": "Unique View ID" - } - ], - "post": { - "summary": "Show All Columns In View", - "operationId": "db-view-show-all-column", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "boolean" - }, - "examples": { - "Example 1": { - "value": true - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "description": "Show All Columns in a given View", - "parameters": [ - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "ignoreIds" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/views/{viewId}/hide-all": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "vw_wtdg2meyig5l4q" - }, - "name": "viewId", - "in": "path", - "required": true, - "description": "Unique View ID" - } - ], - "post": { - "summary": "Hide All Columns In View", - "operationId": "db-view-hide-all-column", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "boolean" - }, - "examples": { - "Example 1": { - "value": true - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "parameters": [ - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "ignoreIds" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "description": "Hide All Columns in a given View" - } - }, - "/api/v1/db/meta/tables/{tableId}/share": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "md_w9gpnaousnfss1", - "type": "string" - }, - "name": "tableId", - "in": "path", - "required": true, - "description": "Unique Table ID" - } - ], - "get": { - "summary": "List Shared Views", - "operationId": "db-view-share-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SharedViewList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:46:31", - "fk_model_id": "md_mhs9z4r2ak98x0", - "id": "vw_lg052cnc1c26kf", - "is_default": 1, - "lock_type": "collaborative", - "meta": {}, - "order": 1, - "project_id": "p_xm3thidrblw4n7", - "show": 1, - "show_system_fields": null, - "title": "Sheet-1", - "type": 3, - "updated_at": "2023-03-02 17:46:31", - "uuid": null, - "view": { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:46:31", - "fk_view_id": "vw_lg052cnc1c26kf", - "meta": null, - "project_id": "p_xm3thidrblw4n7", - "row_height": null, - "updated_at": "2023-03-02 17:46:31", - "uuid": null - } - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "List all shared views in a given Table", - "tags": ["DB View Share"], - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/views/{viewId}/share": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "vw_wtdg2meyig5l4q" - }, - "name": "viewId", - "in": "path", - "required": true, - "description": "Unique View ID" - } - ], - "post": { - "summary": "Create Shared View", - "operationId": "db-view-share-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SharedViewReq" - }, - "examples": { - "Example 1": { - "value": { - "meta": {}, - "password": "123456789" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View Share"], - "description": "Create a shared view in a given View..", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "patch": { - "summary": "Update Shared View", - "operationId": "db-view-share-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SharedView" - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SharedViewReq" - } - } - }, - "description": "" - }, - "tags": ["DB View Share"], - "description": "Update a shared view in a given View..", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "delete": { - "summary": "Delete Shared View", - "operationId": "db-view-share-delete", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "boolean" - }, - "examples": { - "Example 1": { - "value": true - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Delete a shared view in a given View.", - "tags": ["DB View Share"], - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/views/{viewId}/columns": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "vw_wtdg2meyig5l4q" - }, - "name": "viewId", - "in": "path", - "required": true, - "description": "Unique View ID" - } - ], - "get": { - "summary": "List Columns In View", - "operationId": "db-view-column-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ColumnList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "ai": 0, - "au": 0, - "base_id": "ds_krsappzu9f8vmo", - "cc": "", - "cdf": null, - "clen": "45", - "column_name": "title", - "cop": "2", - "created_at": "2023-03-02 13:14:16", - "csn": "utf8mb4", - "ct": "varchar(45)", - "deleted": null, - "dt": "varchar", - "dtx": "specificType", - "dtxp": "45", - "dtxs": null, - "fk_model_id": "md_yvwvbt2i78rgcm", - "id": "cl_0j9gv0oi8vjy46", - "meta": null, - "np": null, - "ns": null, - "order": 2, - "pk": 0, - "project_id": "p_01clqvzik3izk6", - "pv": 1, - "rqd": 0, - "system": 0, - "title": "Title", - "uidt": "SingleLineText", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 13:14:16", - "validate": null, - "virtual": null - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View Column"], - "description": "List all columns by ViewID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "post": { - "summary": "Create Column in View", - "operationId": "db-view-column-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Column" - }, - "examples": { - "Example 1": { - "value": { - "ai": 0, - "au": 0, - "base_id": "ds_krsappzu9f8vmo", - "cc": "", - "cdf": null, - "clen": "45", - "column_name": "title", - "cop": "2", - "created_at": "2023-03-02 13:14:16", - "csn": "utf8mb4", - "ct": "varchar(45)", - "deleted": null, - "dt": "varchar", - "dtx": "specificType", - "dtxp": "45", - "dtxs": null, - "fk_model_id": "md_yvwvbt2i78rgcm", - "id": "cl_0j9gv0oi8vjy46", - "meta": null, - "np": null, - "ns": null, - "order": 2, - "pk": 0, - "project_id": "p_01clqvzik3izk6", - "pv": 1, - "rqd": 0, - "system": 0, - "title": "Title", - "uidt": "SingleLineText", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 13:14:16", - "validate": null, - "virtual": null - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View Column"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ViewColumnReq" - }, - "examples": { - "Example 1": { - "value": { - "fk_column_id": "cl_m4wkaqgqqjzoeh", - "show": 0, - "order": 1 - } - } - } - } - } - }, - "description": "Create a new column in a given View", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/views/{viewId}/columns/{columnId}": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "vw_wtdg2meyig5l4q" - }, - "name": "viewId", - "in": "path", - "required": true - }, - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "cl_8iw2o4ejzvdyna", - "type": "string" - }, - "name": "columnId", - "in": "path", - "required": true, - "description": "Unique Column ID" - } - ], - "patch": { - "summary": "Update View Column", - "operationId": "db-view-column-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number" - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View Column"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ViewColumnUpdateReq" - }, - "examples": { - "Example 1": { - "value": { - "show": 0, - "order": 1 - } - } - } - } - } - }, - "description": "Update a column in a View", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/views/{viewId}/sorts": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "vw_wtdg2meyig5l4q" - }, - "name": "viewId", - "in": "path", - "required": true, - "description": "Unique View ID" - } - ], - "get": { - "summary": "List View Sorts", - "operationId": "db-table-sort-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SortList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "id": "so_xd4t51uv60ghzl", - "fk_column_id": "cl_l11b769pe2j1ce", - "fk_model_id": "md_ehn5izr99m7d45", - "base_id": "ds_3l9qx8xqksenrl", - "direction": "desc", - "order": 1, - "project_id": "p_9sx43moxhqtjm3" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Sort"], - "description": "List all the sort data in a given View", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "post": { - "summary": "Update View Sort", - "operationId": "db-table-sort-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number" - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Sort"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/SortReq" - }, - { - "type": "object", - "properties": { - "push_to_top": { - "type": "boolean", - "example": true, - "description": "Push the sort to the top of the list" - } - } - } - ] - } - } - } - }, - "description": "Update the sort data in a given View", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/sorts/{sortId}": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "so_xd4t51uv60ghzl" - }, - "name": "sortId", - "in": "path", - "description": "Unique Sort ID", - "required": true - } - ], - "get": { - "summary": "Get Sort", - "operationId": "db-table-sort-get", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Sort" - }, - "examples": { - "Example 1": { - "value": { - "id": "so_xd4t51uv60ghzl", - "fk_column_id": "cl_l11b769pe2j1ce", - "fk_model_id": "md_ehn5izr99m7d45", - "base_id": "ds_3l9qx8xqksenrl", - "direction": "desc", - "order": 1, - "project_id": "p_9sx43moxhqtjm3" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Sort"], - "description": "Get the sort data by Sort ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "patch": { - "summary": "Update Sort", - "operationId": "db-table-sort-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number", - "example": 1 - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Sort"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SortReq" - }, - "examples": { - "Example 1": { - "value": { - "direction": "asc", - "fk_column_id": "cl_l11b769pe2j1ce" - } - } - } - } - } - }, - "description": "Update the sort data by Sort ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "delete": { - "summary": "Delete Sort", - "operationId": "db-table-sort-delete", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "boolean" - }, - "examples": { - "Example 1": { - "value": true - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Sort"], - "description": "Delete the sort data by Sort ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/views/{viewId}/filters": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "vw_wtdg2meyig5l4q" - }, - "name": "viewId", - "in": "path", - "required": true, - "description": "Unique View ID" - } - ], - "get": { - "summary": "Get View Filter", - "operationId": "db-table-filter-read", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FilterList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "comparison_op": "eq", - "comparison_sub_op": null, - "created_at": "2023-03-02 18:18:05", - "fk_column_id": "cl_d7ah9n2qfupgys", - "fk_hook_id": null, - "fk_parent_id": null, - "fk_view_id": "vw_b739e29vqmrxnf", - "id": "fi_xn647tpmdq8fu8", - "is_group": null, - "logical_op": "and", - "order": 1, - "project_id": "p_xm3thidrblw4n7", - "updated_at": "2023-03-02 18:18:05", - "value": "foo" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Filter"], - "description": "Get the filter data in a given View", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "post": { - "summary": "Create View Filter", - "operationId": "db-table-filter-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Filter" - }, - "examples": { - "Example 1": { - "value": { - "base_id": "ds_g4ccx6e77h1dmi", - "comparison_op": "eq", - "comparison_sub_op": null, - "created_at": "2023-03-02 18:18:05", - "fk_column_id": "cl_d7ah9n2qfupgys", - "fk_hook_id": null, - "fk_parent_id": null, - "fk_view_id": "vw_b739e29vqmrxnf", - "id": "fi_xn647tpmdq8fu8", - "is_group": null, - "logical_op": "and", - "order": 1, - "project_id": "p_xm3thidrblw4n7", - "updated_at": "2023-03-02 18:18:05", - "value": "foo" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Filter"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FilterReq" - }, - "examples": { - "Example 1": { - "value": { - "comparison_op": "eq", - "comparison_sub_op": null, - "fk_column_id": "cl_d7ah9n2qfupgys", - "is_group": false, - "logical_op": "and", - "value": "foo" - } - } - } - } - } - }, - "description": "Update the filter data in a given View", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/hooks/{hookId}/filters": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "hk_0063k4o1frnxbr" - }, - "name": "hookId", - "in": "path", - "required": true, - "description": "Unique Hook ID" - } - ], - "get": { - "summary": "Get Hook Filter", - "operationId": "db-table-webhook-filter-read", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FilterList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "comparison_op": "eq", - "comparison_sub_op": null, - "created_at": "2023-03-02 18:18:05", - "fk_column_id": "cl_d7ah9n2qfupgys", - "fk_hook_id": null, - "fk_parent_id": null, - "fk_view_id": "vw_b739e29vqmrxnf", - "id": "fi_xn647tpmdq8fu8", - "is_group": null, - "logical_op": "and", - "order": 1, - "project_id": "p_xm3thidrblw4n7", - "updated_at": "2023-03-02 18:18:05", - "value": "foo" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Webhook Filter"], - "description": "Get the filter data in a given Hook", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "post": { - "summary": "Create Hook Filter", - "operationId": "db-table-webhook-filter-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Filter" - }, - "examples": { - "Example 1": { - "value": { - "base_id": "ds_g4ccx6e77h1dmi", - "comparison_op": "eq", - "comparison_sub_op": null, - "created_at": "2023-03-02 18:18:05", - "fk_column_id": "cl_d7ah9n2qfupgys", - "fk_hook_id": null, - "fk_parent_id": null, - "fk_view_id": "vw_b739e29vqmrxnf", - "id": "fi_xn647tpmdq8fu8", - "is_group": null, - "logical_op": "and", - "order": 1, - "project_id": "p_xm3thidrblw4n7", - "updated_at": "2023-03-02 18:18:05", - "value": "foo" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Webhook Filter"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FilterReq" - }, - "examples": { - "Example 1": { - "value": { - "comparison_op": "eq", - "comparison_sub_op": null, - "fk_column_id": "cl_d7ah9n2qfupgys", - "is_group": false, - "logical_op": "and", - "value": "foo" - } - } - } - } - } - }, - "description": "Create filter(s) in a given Hook", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/hooks/{hookId}/logs": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "hk_0063k4o1frnxbr" - }, - "name": "hookId", - "in": "path", - "required": true, - "description": "Unique Hook ID" - } - ], - "get": { - "summary": "List Hook Logs", - "operationId": "db-table-webhook-logs-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HookLogList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "base_id": "ds_jxuewivwbxeum2", - "event": "after", - "execution_time": "98", - "fk_hook_id": "hk_035ijv5qdi97y5", - "id": "string", - "notifications": "{\"type\":\"URL\",\"payload\":{\"method\":\"POST\",\"body\":\"{{ json data }}\",\"headers\":[{}],\"parameters\":[{}],\"auth\":\"\",\"path\":\"https://webhook.site/6eb45ce5-b611-4be1-8b96-c2965755662b\"}}", - "operation": "insert", - "payload": "{\"method\":\"POST\",\"body\":\"{{ json data }}\",\"headers\":[{}],\"parameters\":[{}],\"auth\":\"\",\"path\":\"https://webhook.site/6eb45ce5-b611-4be1-8b96-c2965755662b\"}", - "project_id": "p_tbhl1hnycvhe5l", - "response": "{\"status\":200,\"statusText\":\"OK\",\"headers\":{\"server\":\"nginx\",\"content-type\":\"text/plain; charset=UTF-8\",\"transfer-encoding\":\"chunked\",\"connection\":\"close\",\"vary\":\"Accept-Encoding\",\"x-request-id\":\"53844a7d-ede8-4798-adf7-8af441908a72\",\"x-token-id\":\"6eb45ce5-b611-4be1-8b96-c2965755662b\",\"cache-control\":\"no-cache, private\",\"date\":\"Fri, 24 Mar 2023 10:50:10 GMT\"},\"config\":{\"url\":\"https://webhook.site/6eb45ce5-b611-4be1-8b96-c2965755662b\",\"method\":\"post\",\"data\":\"{\\\"type\\\":\\\"records.after.insert\\\",\\\"id\\\":\\\"a77d97dc-a3e4-4719-9b46-45f93e0cc99a\\\",\\\"data\\\":{\\\"table_id\\\":\\\"md_d8v403o74mf5lf\\\",\\\"table_name\\\":\\\"Sheet-2\\\"}}\",\"headers\":{\"Accept\":\"application/json, text/plain, */*\",\"Content-Type\":\"application/x-www-form-urlencoded\",\"User-Agent\":\"axios/0.21.4\",\"Content-Length\":138},\"params\":{}}}", - "test_call": 0, - "triggered_by": "w@nocodb.com", - "type": "URL" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Webhook Logs"], - "description": "List the log data in a given Hook", - "parameters": [ - { - "schema": { - "type": "integer", - "minimum": 1 - }, - "in": "query", - "name": "limit" - }, - { - "schema": { - "type": "integer", - "minimum": 0 - }, - "in": "query", - "name": "offset" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/filters/{filterId}": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "pattern": "fi_pgfuo11uhn2xeo" - }, - "name": "filterId", - "in": "path", - "required": true, - "description": "Unique Filter ID" - } - ], - "get": { - "summary": "Get Filter", - "operationId": "db-table-filter-get", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Filter" - }, - "examples": { - "Example 1": { - "value": { - "base_id": "ds_g4ccx6e77h1dmi", - "comparison_op": "eq", - "comparison_sub_op": null, - "created_at": "2023-03-02 18:18:05", - "fk_column_id": "cl_d7ah9n2qfupgys", - "fk_hook_id": null, - "fk_parent_id": null, - "fk_view_id": "vw_b739e29vqmrxnf", - "id": "fi_xn647tpmdq8fu8", - "is_group": null, - "logical_op": "and", - "order": 1, - "project_id": "p_xm3thidrblw4n7", - "updated_at": "2023-03-02 18:18:05", - "value": "foo" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Filter"], - "description": "Get the filter data with a given Filter ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "patch": { - "summary": "Update Filter", - "operationId": "db-table-filter-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number" - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Filter"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FilterReq" - }, - "examples": { - "Example 1": { - "value": { - "comparison_op": "eq", - "comparison_sub_op": null, - "fk_column_id": "cl_d7ah9n2qfupgys", - "is_group": false, - "logical_op": "and", - "value": "foo" - } - } - } - } - } - }, - "description": "Update the filter data with a given Filter ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "delete": { - "summary": "Delete Filter", - "operationId": "db-table-filter-delete", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "boolean" - }, - "examples": { - "Example 1": { - "value": true - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Filter"], - "description": "Delete the filter data with a given Filter ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/filters/{filterGroupId}/children": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "fi_pgfuo11uhn2xeo", - "description": "Filter Group ID" - }, - "name": "filterGroupId", - "in": "path", - "required": true - } - ], - "get": { - "summary": "Get Filter Group Children", - "operationId": "db-table-filter-children-read", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FilterList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "comparison_op": "eq", - "comparison_sub_op": null, - "created_at": "2023-03-02 18:18:05", - "fk_column_id": "cl_d7ah9n2qfupgys", - "fk_hook_id": null, - "fk_parent_id": null, - "fk_view_id": "vw_b739e29vqmrxnf", - "id": "fi_xn647tpmdq8fu8", - "is_group": null, - "logical_op": "and", - "order": 1, - "project_id": "p_xm3thidrblw4n7", - "updated_at": "2023-03-02 18:18:05", - "value": "foo" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Filter"], - "description": "Get Filter Group Children of a given group ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/tables/{tableId}/grids": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "md_w9gpnaousnfss1", - "type": "string" - }, - "name": "tableId", - "in": "path", - "required": true, - "description": "Unique Table ID" - } - ], - "post": { - "summary": "Create Grid View", - "operationId": "db-view-grid-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/View" - }, - "examples": { - "Example 1": { - "value": { - "id": "vw_o50jiw9v2txktv", - "base_id": "ds_a95vextjl510z7", - "project_id": "p_slkm6i3v31q4bc", - "fk_model_id": "md_8hr3xndx8umuce", - "title": "Grid-1", - "type": 3, - "is_default": null, - "show_system_fields": null, - "lock_type": "collaborative", - "uuid": null, - "password": null, - "show": true, - "order": 2, - "created_at": "2023-03-13T07:29:16.610Z", - "updated_at": "2023-03-13T07:29:16.610Z", - "meta": {} - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ViewCreateReq" - }, - "examples": { - "Example 1": { - "value": { - "title": "My Grid View", - "type": 3, - "copy_from_id": null, - "fk_grp_col_id": null, - "fk_geo_data_col_id": null - } - } - } - } - } - }, - "description": "Create a new grid view in a given Table", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/tables/{tableId}/forms": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "md_w9gpnaousnfss1", - "type": "string" - }, - "name": "tableId", - "in": "path", - "required": true, - "description": "Unique Table ID" - } - ], - "post": { - "summary": "Create Form View", - "operationId": "db-view-form-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/View" - }, - "examples": { - "Example 1": { - "value": { - "id": "vw_a830n4bmwk8wlp", - "base_id": "ds_a95vextjl510z7", - "project_id": "p_slkm6i3v31q4bc", - "fk_model_id": "md_8hr3xndx8umuce", - "title": "Form-1", - "type": 1, - "is_default": null, - "show_system_fields": null, - "lock_type": "collaborative", - "uuid": null, - "password": null, - "show": true, - "order": 4, - "created_at": "2023-03-13T07:29:19.957Z", - "updated_at": "2023-03-13T07:29:19.957Z", - "meta": {} - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Create a new form view in a given Table", - "tags": ["DB View"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ViewCreateReq" - }, - "examples": { - "Example 1": { - "value": { - "title": "My Form View", - "type": 1, - "copy_from_id": null, - "fk_grp_col_id": null, - "fk_geo_data_col_id": null - } - } - } - } - } - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/forms/{formViewId}": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "vw_6fqln9vdytdv8q" - }, - "name": "formViewId", - "in": "path", - "required": true, - "description": "Unique Form View ID" - } - ], - "patch": { - "summary": "Update Form View", - "operationId": "db-view-form-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number" - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FormUpdateReq" - }, - "examples": { - "Example 1": { - "value": { - "banner_image_url": null, - "email": "user@example.com", - "heading": "My Form", - "lock_type": "collaborative", - "logo_url": null, - "meta": null, - "redirect_after_secs": null, - "redirect_url": null, - "show_blank_form": 0, - "subheading": "My Form Subheading", - "submit_another_form": 0, - "success_msg": "Thank you for the submission.", - "title": "Form View 1" - } - } - } - } - } - }, - "description": "Update the form data by Form ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "get": { - "summary": "Get Form", - "operationId": "db-view-form-read", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Form" - }, - "examples": { - "Example 1": { - "value": { - "base_id": "ds_g4ccx6e77h1dmi", - "banner_image_url": null, - "columns": [ - { - "id": "fvc_ugj9zo5bzocxtl", - "base_id": "ds_g4ccx6e77h1dmi", - "project_id": "p_xm3thidrblw4n7", - "fk_view_id": "vw_kdf5cr7qmhksek", - "fk_column_id": "cl_phvuuwjrzcdo0g", - "uuid": null, - "label": null, - "help": null, - "description": null, - "required": null, - "show": 0, - "order": 1, - "created_at": "2023-03-04 16:40:47", - "updated_at": "2023-03-04 16:40:47", - "meta": {} - } - ], - "email": "user@example.com", - "fk_model_id": "md_rsu68aqjsbyqtl", - "heading": "My Form", - "lock_type": "collaborative", - "logo_url": null, - "meta": null, - "redirect_after_secs": null, - "redirect_url": null, - "show_blank_form": 0, - "subheading": "My Form Subheading", - "submit_another_form": 0, - "success_msg": "Thank you for the submission.", - "title": "Form View 1" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "description": "Get the form data by Form ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/form-columns/{formViewColumnId}": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "fvc_1m9b0aub791d4m", - "type": "string" - }, - "name": "formViewColumnId", - "in": "path", - "required": true, - "description": "Unique Form View Column ID" - } - ], - "patch": { - "summary": "Update Form Column", - "operationId": "db-view-form-column-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FormColumnReq" - }, - "examples": { - "Example 1": { - "value": { - "description": null, - "help": "This is a help text", - "label": "Form Label", - "meta": null, - "order": 1, - "required": 0, - "show": 0 - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FormColumnReq" - } - } - } - }, - "description": "Update the form column(s) by Form View Column ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/grids/{viewId}": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "vw_wtdg2meyig5l4q" - }, - "name": "viewId", - "in": "path", - "required": true, - "description": "Unique View ID" - } - ], - "patch": { - "summary": "Update Grid View", - "operationId": "db-view-grid-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number" - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GridUpdateReq" - }, - "examples": { - "Example 1": { - "value": { - "row_height": 1, - "meta": null - } - } - } - } - } - }, - "description": "Update Grid View", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/grids/{gridId}/grid-columns": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "vw_q6k13mmygdi3yz" - }, - "name": "gridId", - "in": "path", - "required": true, - "description": "Grid View ID" - } - ], - "get": { - "summary": "List Grid Columns", - "operationId": "db-view-grid-columns-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GridColumn" - } - }, - "examples": { - "Example 1": { - "value": [ - { - "id": "nc_c8jz4kxe6xvh11", - "fk_view_id": "vw_p2jcatxz4mvcfw", - "fk_column_id": "cl_c5knoi4xs4sfpt", - "project_id": "p_xm3thidrblw4n7", - "base_id": "ds_g4ccx6e77h1dmi", - "show": 0, - "order": 1, - "width": "200px", - "help": null - } - ] - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "description": "List all columns in the given Grid", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/grid-columns/{columnId}": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "cl_8iw2o4ejzvdyna", - "type": "string" - }, - "name": "columnId", - "in": "path", - "required": true, - "description": "Unique Column ID" - } - ], - "patch": { - "summary": "Update Grid Column", - "operationId": "db-view-grid-column-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number" - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GridColumnReq" - }, - "examples": { - "Example 1": { - "value": { - "fk_column_id": "cl_c5knoi4xs4sfpt", - "label": "My Column", - "width": "200px" - } - } - } - } - } - }, - "description": "Update grid column(s) in the given Grid", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/tables/{tableId}/galleries": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "md_w9gpnaousnfss1" - }, - "name": "tableId", - "in": "path", - "required": true, - "description": "Unique Table ID" - } - ], - "post": { - "summary": "Create Gallery View", - "operationId": "db-view-gallery-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/View" - }, - "examples": { - "Example 1": { - "value": { - "id": "vw_qp94qfnvffgk5f", - "base_id": "ds_a95vextjl510z7", - "project_id": "p_slkm6i3v31q4bc", - "fk_model_id": "md_8hr3xndx8umuce", - "title": "Gallery-1", - "type": 2, - "is_default": null, - "show_system_fields": null, - "lock_type": "collaborative", - "uuid": null, - "password": null, - "show": true, - "order": 3, - "created_at": "2023-03-13T07:29:18.707Z", - "updated_at": "2023-03-13T07:29:18.707Z", - "meta": {} - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ViewCreateReq" - }, - "examples": { - "Example 1": { - "value": { - "title": "My Gallery View", - "type": 2, - "copy_from_id": null, - "fk_grp_col_id": null, - "fk_geo_data_col_id": null - } - } - } - } - } - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/galleries/{galleryViewId}": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "vw_1eq2wk2xe3a9j5" - }, - "name": "galleryViewId", - "in": "path", - "required": true, - "description": "Unique Gallery View ID" - } - ], - "patch": { - "summary": "Update Gallery View", - "operationId": "db-view-gallery-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number" - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GalleryUpdateReq" - }, - "examples": { - "Example 1": { - "value": { - "fk_cover_image_col_id": "cl_ib8l4j1kiu1efx", - "meta": null - } - } - } - } - } - }, - "description": "Update the Gallery View data with Gallery ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "get": { - "summary": "Get Gallery View", - "operationId": "db-view-gallery-read", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Gallery" - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "description": "Get the Gallery View data with Gallery ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/tables/{tableId}/kanbans": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "md_w9gpnaousnfss1", - "type": "string" - }, - "name": "tableId", - "in": "path", - "required": true, - "description": "Unique Table ID" - } - ], - "post": { - "summary": "Create Kanban View", - "operationId": "db-view-kanban-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/View" - }, - "examples": { - "Example 1": { - "value": { - "id": "vw_569sqsrp2vuff4", - "base_id": "ds_a95vextjl510z7", - "project_id": "p_slkm6i3v31q4bc", - "fk_model_id": "md_8hr3xndx8umuce", - "title": "Kanban-1", - "type": 4, - "is_default": null, - "show_system_fields": null, - "lock_type": "collaborative", - "uuid": null, - "password": null, - "show": true, - "order": 5, - "created_at": "2023-03-13T07:29:21.387Z", - "updated_at": "2023-03-13T07:29:21.387Z", - "meta": {} - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ViewCreateReq" - }, - "examples": { - "Example 1": { - "value": { - "title": "My Kanban View", - "type": 4, - "copy_from_id": null, - "fk_grp_col_id": "cl_g0a89q9xdry3lu", - "fk_geo_data_col_id": null - } - } - } - } - } - }, - "description": "Create a new Kanban View", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/kanbans/{kanbanViewId}": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "vw_1eq2wk2xe3a9j5" - }, - "name": "kanbanViewId", - "in": "path", - "required": true, - "description": "Unique Kanban View ID" - } - ], - "patch": { - "summary": "Update Kanban View", - "operationId": "db-view-kanban-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number" - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/KanbanUpdateReq" - }, - "examples": { - "Example 1": { - "value": { - "fk_grp_col_id": "cl_g0a89q9xdry3lu", - "fk_cover_image_col_id": "cl_ib8l4j1kiu1efx", - "meta": { - "cl_g0a89q9xdry3lu": [ - { - "id": "uncategorized", - "title": null, - "order": 0, - "color": "#c2f5e8", - "collapsed": false - }, - { - "id": "sl_ihyva6jx6dg0fc", - "fk_column_id": "cl_g0a89q9xdry3lu", - "title": "a", - "color": "#cfdffe", - "order": 1, - "collapsed": false - }, - { - "id": "sl_gqdm5v6t8aetoa", - "fk_column_id": "cl_g0a89q9xdry3lu", - "title": "b", - "color": "#d0f1fd", - "order": 2, - "collapsed": false - }, - { - "id": "sl_eipnl0kn7a9d3c", - "fk_column_id": "cl_g0a89q9xdry3lu", - "title": "cc", - "color": "#c2f5e8", - "order": 3, - "collapsed": false - }, - { - "id": "sl_dei8p2jq0cnlv0", - "fk_column_id": "cl_g0a89q9xdry3lu", - "title": "d", - "color": "#ffdaf6", - "order": 4, - "collapsed": false - } - ] - } - } - } - } - } - } - }, - "description": "Update the Kanban View data with Kanban ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "get": { - "summary": "Get Kanban View", - "operationId": "db-view-kanban-read", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Kanban" - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "description": "Get the Kanban View data by Kanban ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/tables/{tableId}/maps": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "md_w9gpnaousnfss1", - "type": "string" - }, - "name": "tableId", - "in": "path", - "required": true, - "description": "Unique Table ID" - } - ], - "post": { - "summary": "Create Map View", - "operationId": "db-view-map-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/View" - }, - "examples": { - "Example 1": { - "value": { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:46:31", - "fk_model_id": "md_mhs9z4r2ak98x0", - "id": "vw_lg052cnc1c26kf", - "is_default": 1, - "lock_type": "collaborative", - "meta": {}, - "order": 1, - "password": null, - "project_id": "p_xm3thidrblw4n7", - "show": 1, - "show_system_fields": null, - "title": "Sheet-1", - "type": 3, - "updated_at": "2023-03-02 17:46:31", - "uuid": null - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ViewCreateReq" - }, - "examples": { - "Example 1": { - "value": { - "title": "My Map View", - "type": 5, - "copy_from_id": null, - "fk_grp_col_id": null, - "fk_geo_data_col_id": "cl_uu1meolj00tlrq" - } - } - } - } - }, - "description": "" - }, - "description": "Create a new Map View", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/maps/{mapViewId}": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "vw_1eq2wk2xe3a9j5" - }, - "name": "mapViewId", - "in": "path", - "required": true, - "description": "Unique Map View ID" - } - ], - "patch": { - "summary": "Update Map View", - "operationId": "db-view-map-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number" - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/MapUpdateReq" - }, - "examples": { - "Example 1": { - "value": { - "fk_geo_data_col_id": "cl_8iw2o4ejzvdyna", - "meta": null - } - } - } - } - } - }, - "description": "Update the Map View data by Map ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "get": { - "summary": "Get Map View", - "operationId": "db-view-map-read", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Map" - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "description": "Get the Map View data by Map ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/projects/{projectId}/meta-diff": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - } - ], - "post": { - "summary": "Sync Meta", - "operationId": "project-meta-diff-sync", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "la6fd99uw6eao" - }, - "example": "The meta has been synchronized successfully" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "The meta has been synchronized successfully" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Project"], - "description": "Synchronise the meta data difference between NC_DB and external data sources ", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "get": { - "summary": "Meta Diff", - "operationId": "project-meta-diff-get", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["Project"], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "x-stoplight": { - "id": "awdkjwr7uultr" - }, - "type": "object", - "properties": { - "table_name": { - "type": "string", - "x-stoplight": { - "id": "jjj8ufafq1sd2" - }, - "description": "Table Name", - "example": "Table 1" - }, - "base_id": { - "type": "string", - "x-stoplight": { - "id": "smx2or6bv1xym" - }, - "description": "Base ID", - "example": "ds_rrplkgy0pq1f3c" - }, - "type": { - "type": "string", - "x-stoplight": { - "id": "zr19ahh1s6d13" - }, - "description": "Change Type", - "example": "table" - }, - "detectedChanges": { - "type": "array", - "x-stoplight": { - "id": "bptxla2y27aq6" - }, - "description": "Detected Changes", - "items": { - "x-stoplight": { - "id": "ob16o1ln7xy8o" - }, - "type": "object" - } - } - } - } - }, - "examples": { - "Example 1": { - "value": [ - { - "table_name": "_nc_m2m_uuv_xzru3m", - "base_id": "ds_rrplkgy0pq1f3c", - "type": "table", - "detectedChanges": [ - { - "type": "TABLE_NEW", - "msg": "New table" - }, - { - "type": "TABLE_RELATION_ADD", - "tn": "_nc_m2m_uuv_xzru3m", - "rtn": "Sheet-1", - "cn": "table1_id", - "rcn": "id", - "msg": "New relation added", - "relationType": "bt", - "cstn": "_nc_m2m_uuv_xzru3m_table1_id_foreign" - }, - { - "type": "TABLE_RELATION_ADD", - "tn": "_nc_m2m_uuv_xzru3m", - "rtn": "address", - "cn": "table2_id", - "rcn": "address_id", - "msg": "New relation added", - "relationType": "bt", - "cstn": "_nc_m2m_uuv_xzru3m_table2_id_foreign" - } - ] - } - ] - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Get the meta data difference between NC_DB and external data sources " - } - }, - "/api/v1/db/meta/projects/{projectId}/meta-diff/{baseId}": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - }, - { - "schema": { - "type": "string", - "pattern": "ds_j04jmxh5xg10lu" - }, - "name": "baseId", - "in": "path", - "required": true, - "description": "Unique Base ID" - } - ], - "post": { - "summary": "Synchronise Base Meta", - "operationId": "base-meta-diff-sync", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "acy7tx4rounqw" - }, - "example": "The base meta has been synchronized successfully" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "The base meta has been synchronized successfully" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Base"], - "description": "Synchronise the meta data difference between NC_DB and external data sources in a given Base", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "get": { - "summary": "Base Meta Diff", - "operationId": "base-meta-diff-get", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["Base"], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "x-stoplight": { - "id": "pav4jmel1ebeu" - }, - "type": "object", - "properties": { - "table_name": { - "type": "string", - "x-stoplight": { - "id": "xjw4k4httzmaf" - }, - "description": "Table Name", - "example": "Table 1" - }, - "base_id": { - "type": "string", - "x-stoplight": { - "id": "l1o3qhkgagsdl" - }, - "example": "ds_rrplkgy0pq1f3c", - "description": "Base ID" - }, - "type": { - "type": "string", - "x-stoplight": { - "id": "v5ciaygrj64uh" - }, - "description": "Change Type", - "example": "table" - }, - "detectedChanges": { - "type": "array", - "x-stoplight": { - "id": "wqn5noi0e46q8" - }, - "description": "Detected Changes", - "items": { - "x-stoplight": { - "id": "r2roo274wquvf" - }, - "type": "object" - } - } - } - } - }, - "examples": { - "Example 1": { - "value": [ - { - "table_name": "_nc_m2m_uuv_xzru3m", - "base_id": "ds_rrplkgy0pq1f3c", - "type": "table", - "detectedChanges": [ - { - "type": "TABLE_NEW", - "msg": "New table" - }, - { - "type": "TABLE_RELATION_ADD", - "tn": "_nc_m2m_uuv_xzru3m", - "rtn": "Sheet-1", - "cn": "table1_id", - "rcn": "id", - "msg": "New relation added", - "relationType": "bt", - "cstn": "_nc_m2m_uuv_xzru3m_table1_id_foreign" - }, - { - "type": "TABLE_RELATION_ADD", - "tn": "_nc_m2m_uuv_xzru3m", - "rtn": "address", - "cn": "table2_id", - "rcn": "address_id", - "msg": "New relation added", - "relationType": "bt", - "cstn": "_nc_m2m_uuv_xzru3m_table2_id_foreign" - } - ] - } - ] - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Get the meta data difference between NC_DB and external data sources in a given Base" - } - }, - "/api/v1/db/meta/projects/{projectId}/has-empty-or-null-filters": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - } - ], - "get": { - "summary": "List Empty & Null Filter", - "operationId": "project-has-empty-or-null-filters", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["Project"], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": {} - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Check if a project contains empty and null filters. Used in `Show NULL and EMPTY in Filter` in Project Setting.", - "x-internal": true - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - } - ], - "get": { - "summary": "List Table Rows", - "operationId": "db-table-row-list", - "description": "List all table rows in a given table and project", - "tags": ["DB Table Row"], - "parameters": [ - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "fields", - "description": "Which fields to be shown" - }, - { - "schema": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "type": "string" - } - ] - }, - "in": "query", - "name": "sort", - "description": "The result will be sorted based on `sort` query" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where", - "description": "Extra filtering" - }, - { - "schema": { - "type": "integer", - "minimum": 0 - }, - "in": "query", - "name": "offset", - "description": "Offset in rows" - }, - { - "schema": { - "type": "integer", - "minimum": 1 - }, - "in": "query", - "name": "limit", - "description": "Limit in rows" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "sortArrJson", - "description": "Used for multiple sort queries" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "filterArrJson", - "description": "Used for multiple filter queries" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "list": { - "type": "array", - "x-stoplight": { - "id": "g92aqxk869a7o" - }, - "description": "List of data objects", - "items": { - "x-stoplight": { - "id": "rnbt8ubciknfd" - }, - "type": "object" - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated", - "x-stoplight": { - "id": "7f38yyzdg03x5" - }, - "description": "Paginated Info" - } - }, - "required": ["list", "pageInfo"] - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "Id": 1, - "Title": "baz", - "SingleSelect": null, - "Sheet-1 List": [ - { - "Id": 1, - "Title": "baz" - } - ], - "LTAR": [ - { - "Id": 1, - "Title": "baz" - } - ] - }, - { - "Id": 2, - "Title": "foo", - "SingleSelect": "a", - "Sheet-1 List": [ - { - "Id": 2, - "Title": "foo" - } - ], - "LTAR": [ - { - "Id": 2, - "Title": "foo" - } - ] - }, - { - "Id": 3, - "Title": "bar", - "SingleSelect": "b", - "Sheet-1 List": [], - "LTAR": [] - } - ], - "pageInfo": { - "totalRows": 3, - "page": 1, - "pageSize": 25, - "isFirstPage": true, - "isLastPage": true - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - } - }, - "post": { - "summary": "Create Table Row", - "operationId": "db-table-row-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": {} - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Row"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "examples": { - "Example 1": { - "value": { - "Id": 1, - "Title": "foo", - "CreatedAt": "2023-03-11T09:10:53.567Z", - "UpdatedAt": "2023-03-11T09:10:53.567Z" - } - } - } - } - } - }, - "description": "Create a new row in a given table and project.", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/find-one": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - } - ], - "get": { - "summary": "Find One Table Row", - "operationId": "db-table-row-find-one", - "description": "Return the first result of the target Table Row", - "tags": ["DB Table Row"], - "parameters": [ - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "fields" - }, - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "sort" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "examples": { - "Example 1": { - "value": { - "Id": 1, - "Title": "foo", - "CreatedAt": "2023-03-11T09:10:53.567Z", - "UpdatedAt": "2023-03-11T09:10:53.567Z" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - } - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/groupby": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "column_name", - "description": "Column name of the column you want to group by, eg. `column_name=column1`" - } - ], - "get": { - "summary": "Group By Table Row", - "operationId": "db-table-row-group-by", - "description": "Get the result grouped by the given query", - "tags": ["DB Table Row"], - "parameters": [ - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "sort" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where" - }, - { - "schema": { - "type": "integer", - "minimum": 1 - }, - "in": "query", - "name": "limit" - }, - { - "schema": { - "type": "integer", - "minimum": 0 - }, - "in": "query", - "name": "offset" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": {} - } - } - } - } - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/views/{viewName}/group/{columnId}": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string", - "example": "p_tbhl1hnycvhe5l" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string", - "example": "md_5hua2iqloqirhd" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "type": "string", - "example": "vw_mldv0a5mtwh1la" - }, - "name": "viewName", - "in": "path", - "required": true, - "description": "View Name" - }, - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "cl_8iw2o4ejzvdyna", - "type": "string" - }, - "name": "columnId", - "in": "path", - "required": true, - "description": "Unique Column ID" - } - ], - "get": { - "summary": "Table Group by Column", - "operationId": "db-view-row-grouped-data-list", - "description": "Get the grouped data By Column ID. Used in Kanban View.", - "tags": ["DB View Row"], - "parameters": [ - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "fields" - }, - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "sort" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where" - }, - { - "schema": {}, - "in": "query", - "name": "nested", - "description": "Query params for nested data" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": {} - }, - "examples": { - "Example 1": { - "value": [ - { - "key": "a", - "value": { - "list": [ - { - "Id": 2, - "Title": "foo", - "SingleSelect": "a" - } - ], - "pageInfo": { - "totalRows": 1, - "page": 1, - "pageSize": 25, - "isFirstPage": true, - "isLastPage": true - } - } - }, - { - "key": "b", - "value": { - "list": [ - { - "Id": 3, - "Title": "bar", - "SingleSelect": "b" - } - ], - "pageInfo": { - "totalRows": 1, - "page": 1, - "pageSize": 25, - "isFirstPage": true, - "isLastPage": true - } - } - }, - { - "key": null, - "value": { - "list": [ - { - "Id": 1, - "Title": "baz", - "SingleSelect": null - }, - { - "Id": 5, - "Title": "xyz", - "SingleSelect": null - } - ], - "pageInfo": { - "totalRows": 2, - "page": 1, - "pageSize": 25, - "isFirstPage": true, - "isLastPage": true - } - } - } - ] - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - } - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/group/{columnId}": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string", - "example": "p_tbhl1hnycvhe5l" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string", - "example": "md_5hua2iqloqirhd" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "cl_8iw2o4ejzvdyna", - "type": "string" - }, - "name": "columnId", - "in": "path", - "required": true, - "description": "Unique Column ID" - } - ], - "get": { - "summary": "Table Group by Column", - "operationId": "db-table-row-grouped-data-list", - "description": "Get the grouped data By Column ID. Used in Kanban View.", - "tags": ["DB Table Row"], - "parameters": [ - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "fields" - }, - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "sort" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where" - }, - { - "schema": {}, - "in": "query", - "name": "nested", - "description": "Query params for nested data" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": {} - }, - "examples": { - "Example 1": { - "value": [ - { - "key": "a", - "value": { - "list": [ - { - "Id": 2, - "Title": "foo", - "SingleSelect": "a" - } - ], - "pageInfo": { - "totalRows": 1, - "page": 1, - "pageSize": 25, - "isFirstPage": true, - "isLastPage": true - } - } - }, - { - "key": "b", - "value": { - "list": [ - { - "Id": 3, - "Title": "bar", - "SingleSelect": "b" - } - ], - "pageInfo": { - "totalRows": 1, - "page": 1, - "pageSize": 25, - "isFirstPage": true, - "isLastPage": true - } - } - }, - { - "key": null, - "value": { - "list": [ - { - "Id": 1, - "Title": "baz", - "SingleSelect": null - }, - { - "Id": 5, - "Title": "xyz", - "SingleSelect": null - } - ], - "pageInfo": { - "totalRows": 2, - "page": 1, - "pageSize": 25, - "isFirstPage": true, - "isLastPage": true - } - } - } - ] - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - } - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/views/{viewName}": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "type": "string" - }, - "name": "viewName", - "in": "path", - "required": true - } - ], - "get": { - "summary": "List Table View Rows", - "operationId": "db-view-row-list", - "description": "List all table view rows", - "tags": ["DB View Row"], - "parameters": [ - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "fields" - }, - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "sort" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where" - }, - { - "schema": {}, - "in": "query", - "name": "nested", - "description": "Query params for nested data" - }, - { - "schema": { - "type": "number" - }, - "in": "query", - "name": "offset" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "list": { - "type": "array", - "x-stoplight": { - "id": "okd8utzm9xqet" - }, - "description": "List of table view rows", - "items": { - "x-stoplight": { - "id": "j758lsjv53o4q" - }, - "type": "object" - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated", - "x-stoplight": { - "id": "hylgqzgm8yhye" - }, - "description": "Paginated Info" - } - }, - "required": ["list", "pageInfo"] - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "Id": 1, - "Title": "baz", - "SingleSelect": null, - "Sheet-1 List": [ - { - "Id": 1, - "Title": "baz" - } - ], - "LTAR": [ - { - "Id": 1, - "Title": "baz" - } - ] - }, - { - "Id": 2, - "Title": "foo", - "SingleSelect": "a", - "Sheet-1 List": [ - { - "Id": 2, - "Title": "foo" - } - ], - "LTAR": [ - { - "Id": 2, - "Title": "foo" - } - ] - }, - { - "Id": 3, - "Title": "bar", - "SingleSelect": "b", - "Sheet-1 List": [], - "LTAR": [] - } - ], - "pageInfo": { - "totalRows": 3, - "page": 1, - "pageSize": 25, - "isFirstPage": true, - "isLastPage": true - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - } - }, - "post": { - "summary": "Create Table View Row", - "operationId": "db-view-row-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "examples": { - "Example 1": { - "value": { - "Id": 1, - "col1": "foo", - "col2": "bar", - "CreatedAt": "2023-03-11T08:48:25.598Z", - "UpdatedAt": "2023-03-11T08:48:25.598Z" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View Row"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "examples": { - "Example 1": { - "value": { - "col1": "foo", - "col2": "bar" - } - } - } - } - } - }, - "description": "Create a new row in the given Table View" - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/views/{viewName}/find-one": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "type": "string" - }, - "name": "viewName", - "in": "path", - "required": true - } - ], - "get": { - "summary": "Find One Table View Row", - "operationId": "db-view-row-find-one", - "description": "Return the first result of table view rows with the given query", - "tags": ["DB View Row"], - "parameters": [ - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "fields" - }, - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "sort" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where" - }, - { - "schema": {}, - "in": "query", - "name": "nested", - "description": "Query params for nested data" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "examples": { - "Example 1": { - "value": { - "Id": 1, - "Title": "foo", - "CreatedAt": "2023-03-11T09:10:53.567Z", - "UpdatedAt": "2023-03-11T09:10:53.567Z" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - } - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/views/{viewName}/groupby": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "type": "string" - }, - "name": "viewName", - "in": "path", - "required": true - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "column_name", - "description": "Column name of the column you want to group by, eg. `column_name=column1`" - } - ], - "get": { - "summary": "Group By Table View Row", - "operationId": "db-view-row-group-by", - "description": "Get the table view rows groupe by the given query", - "tags": ["DB View Row"], - "parameters": [ - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "sort" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where" - }, - { - "schema": { - "type": "integer", - "minimum": 1 - }, - "in": "query", - "name": "limit" - }, - { - "schema": { - "type": "integer", - "minimum": 0 - }, - "in": "query", - "name": "offset" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": {} - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - } - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/views/{viewName}/count": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "type": "string", - "example": "vw_75neroyqdye94k" - }, - "name": "viewName", - "in": "path", - "required": true, - "description": "View Name" - } - ], - "get": { - "summary": "Count Table View Rows", - "operationId": "db-view-row-count", - "description": "Count how many rows in the given Table View", - "tags": ["DB View Row"], - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where" - }, - { - "schema": {}, - "in": "query", - "name": "nested", - "description": "Query params for nested data" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "count": { - "type": "number", - "x-stoplight": { - "id": "hwq29x70rcipi" - } - } - } - }, - "examples": { - "Example 1": { - "value": { - "count": 25 - } - } - } - } - } - } - } - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/views/{viewName}/{rowId}": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "type": "string", - "example": "vw_75neroyqdye94k" - }, - "name": "viewName", - "in": "path", - "required": true, - "description": "View Name" - }, - { - "schema": { - "example": "1" - }, - "name": "rowId", - "in": "path", - "required": true, - "description": "Unique Row ID" - } - ], - "get": { - "summary": "Get Table View Row", - "operationId": "db-view-row-read", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {} - }, - "examples": { - "Example 1": { - "value": { - "Id": 1, - "Title": "foo", - "CreatedAt": "2023-03-11T09:11:47.437Z", - "UpdatedAt": "2023-03-11T09:11:47.784Z" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Get the target Table View Row", - "tags": ["DB View Row"], - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "patch": { - "summary": "Update Table View Row", - "operationId": "db-view-row-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "examples": { - "Example 1": { - "value": { - "Id": 1, - "Title": "bar", - "CreatedAt": "2023-03-11T09:11:47.437Z", - "UpdatedAt": "2023-03-11T09:20:21.133Z" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View Row"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "examples": { - "Example 1": { - "value": { - "Title": "bar" - } - } - } - } - } - }, - "description": "Update the target Table View Row", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "delete": { - "summary": "Delete Table View Row", - "operationId": "db-view-row-delete", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number" - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View Row"], - "description": "Delete the target Table View Row", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/views/{viewName}/{rowId}/exist": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "type": "string" - }, - "name": "viewName", - "in": "path", - "required": true - }, - { - "schema": { - "example": "1" - }, - "name": "rowId", - "in": "path", - "required": true, - "description": "Unique Row ID" - } - ], - "get": { - "summary": "Does Table View Row Exist", - "operationId": "db-view-row-exist", - "responses": { - "201": { - "description": "Created", - "content": { - "application/json": { - "schema": { - "type": "number" - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Check row with provided primary key exists or not", - "tags": ["DB View Row"], - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/{rowId}": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "example": "1" - }, - "name": "rowId", - "in": "path", - "required": true, - "description": "Unique Row ID" - } - ], - "get": { - "summary": "Get Table Row", - "operationId": "db-table-row-read", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {} - }, - "examples": { - "Example 1": { - "value": { - "Id": 1, - "Title": "foo", - "CreatedAt": "2023-03-11T09:11:47.437Z", - "UpdatedAt": "2023-03-11T09:11:47.784Z" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Get the Table Row by Row ID", - "tags": ["DB Table Row"], - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "patch": { - "summary": "Update Table Row", - "operationId": "db-table-row-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "examples": { - "Example 1": { - "value": { - "Id": 1, - "Title": "bar", - "CreatedAt": "2023-03-11T09:11:47.437Z", - "UpdatedAt": "2023-03-11T09:20:21.133Z" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Row"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "examples": { - "Example 1": { - "value": { - "Title": "bar" - } - } - } - } - } - }, - "description": "Update the Table Row", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "delete": { - "summary": "Delete Table Row", - "operationId": "db-table-row-delete", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number" - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Row"], - "description": "Delete the Table Row", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/{rowId}/exist": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "example": "1" - }, - "name": "rowId", - "in": "path", - "required": true, - "description": "Unique Row ID" - } - ], - "get": { - "summary": "Does Table Row Exist", - "operationId": "db-table-row-exist", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number" - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "check row with provided primary key exists or not", - "tags": ["DB Table Row"], - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/data/bulk/{orgs}/{projectName}/{tableName}": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - } - ], - "post": { - "summary": "Bulk Insert Table Rows", - "operationId": "db-table-row-bulk-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "description": "List of returned IDs", - "items": { - "x-stoplight": { - "id": "dbkhyd3mnajax" - }, - "type": "object", - "properties": { - "id": { - "type": "string", - "x-stoplight": { - "id": "lnwqjl14f287f" - } - } - } - } - }, - "examples": { - "Example 1": { - "value": [ - { - "id": 1 - }, - { - "id": 2 - } - ] - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Row"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "array", - "description": "List of data objects", - "items": { - "x-stoplight": { - "id": "7u0mp8nzlvysz" - }, - "type": "object" - } - }, - "examples": { - "Example 1": { - "value": [ - { - "Title": "abc" - }, - { - "Title": "def" - } - ] - } - } - } - }, - "description": "" - }, - "description": "Bulk insert table rows in one go.", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "patch": { - "summary": "Bulk Update Table Rows by IDs", - "operationId": "db-table-row-bulk-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "description": "List of returned values. 1 means successful. 0 means failed.", - "items": { - "x-stoplight": { - "id": "ga0xhsahovdt7" - }, - "type": "number" - } - }, - "examples": { - "Example 1": { - "value": [1, 1] - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Row"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "array", - "description": "List of data objects", - "items": { - "x-stoplight": { - "id": "q2xtbf29i1s5n" - }, - "type": "object" - } - }, - "examples": { - "Example 1": { - "value": [ - { - "Id": "1", - "Title": "123" - }, - { - "Id": "2", - "Title": "456" - } - ] - } - } - } - } - }, - "description": "Bulk Update Table Rows by given IDs", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "delete": { - "summary": "Bulk Delete Table Rows by IDs", - "operationId": "db-table-row-bulk-delete", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "x-stoplight": { - "id": "b9o9o2r6ipho9" - }, - "type": "number" - } - }, - "examples": { - "Example 1": { - "value": [1, 1] - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Row"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "x-stoplight": { - "id": "sd8udhhjnqiay" - }, - "type": "object" - } - }, - "examples": { - "Example 1": { - "value": [ - { - "Id": "1" - }, - { - "Id": "2" - } - ] - } - } - } - }, - "description": "" - }, - "description": "Bulk Delete Table Rows by given IDs", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/data/bulk/{orgs}/{projectName}/{tableName}/all": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where" - } - ], - "patch": { - "summary": "Bulk Update Table Rows with Conditions", - "operationId": "db-table-row-bulk-update-all", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": {}, - "examples": { - "Example 1": { - "value": [ - { - "Id": "1" - }, - { - "Id": "2" - } - ] - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Row"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "examples": { - "Example 1": { - "value": { - "Title": "foo" - } - } - } - } - } - }, - "description": "Bulk Update all Table Rows if the condition is true", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "delete": { - "summary": "Bulk Delete Table Rows with Conditions", - "operationId": "db-table-row-bulk-delete-all", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "x-stoplight": { - "id": "9gcl3ok7is3y0" - }, - "type": "object" - } - }, - "examples": { - "Example 1": { - "value": [1, 1] - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Row"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "examples": { - "Example 1": { - "value": { - "Title": "foo" - } - } - } - } - } - }, - "description": "Bulk Delete all Table Rows if the condition is true", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/views/{viewName}/export/{type}": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "type": "string" - }, - "name": "viewName", - "in": "path", - "required": true - }, - { - "schema": { - "type": "string", - "enum": ["csv", "excel"] - }, - "name": "type", - "in": "path", - "required": true - } - ], - "get": { - "summary": "Export Table View Rows", - "operationId": "db-view-row-export", - "description": "Export Table View Rows by CSV or Excel", - "tags": ["DB View Row"], - "wrapped": true, - "responses": { - "200": { - "description": "OK", - "content": { - "application/octet-stream": { - "schema": {} - } - }, - "headers": { - "nc-export-offset": { - "schema": { - "type": "integer" - }, - "description": "The starting offset of the next set of rows" - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/export/{type}": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "type": "string", - "enum": ["csv", "excel"] - }, - "name": "type", - "in": "path", - "required": true - } - ], - "get": { - "summary": "Export Table View Rows", - "operationId": "db-table-row-csv-export", - "description": "Export Table View Rows by CSV or Excel", - "tags": ["DB Table Row"], - "wrapped": true, - "responses": { - "200": { - "description": "OK", - "content": { - "application/octet-stream": { - "schema": {} - } - }, - "headers": { - "nc-export-offset": { - "schema": { - "type": "integer" - }, - "description": "The starting offset of the next set of rows" - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/{rowId}/{relationType}/{columnName}": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "example": "1" - }, - "name": "rowId", - "in": "path", - "required": true, - "description": "Unique Row ID" - }, - { - "schema": { - "type": "string", - "enum": ["mm", "hm", "bt"] - }, - "name": "relationType", - "in": "path", - "required": true, - "description": "Relation Type" - }, - { - "schema": { - "type": "string" - }, - "name": "columnName", - "in": "path", - "required": true, - "description": "Column Name" - } - ], - "get": { - "summary": "List Nested Relations Rows", - "operationId": "db-table-row-nested-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": {} - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Row"], - "parameters": [ - { - "schema": { - "type": "integer", - "minimum": 1 - }, - "in": "query", - "name": "limit" - }, - { - "schema": { - "type": "integer", - "minimum": 0 - }, - "in": "query", - "name": "offset" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "description": "List all nested relations rows" - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/{rowId}/{relationType}/{columnName}/{refRowId}": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "example": "1" - }, - "name": "rowId", - "in": "path", - "required": true, - "description": "Unique Row ID" - }, - { - "schema": { - "type": "string", - "enum": ["mm", "hm", "bt"] - }, - "name": "relationType", - "in": "path", - "required": true - }, - { - "schema": { - "type": "string" - }, - "name": "columnName", - "in": "path", - "required": true - }, - { - "schema": { - "type": "string" - }, - "name": "refRowId", - "in": "path", - "required": true - } - ], - "post": { - "summary": "Create Nested Relations Row", - "operationId": "db-table-row-nested-add", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "m6jox00hxgd6s" - }, - "example": "The relation data has been created successfully" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "The relation data has been created successfully" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Row"], - "parameters": [ - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "fields", - "description": "Which fields to be shown" - }, - { - "schema": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "type": "string" - } - ] - }, - "in": "query", - "name": "sort", - "description": "The result will be sorted based on `sort` query" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where", - "description": "Extra filtering" - }, - { - "schema": { - "type": "integer", - "minimum": 0 - }, - "in": "query", - "name": "offset", - "description": "Offset in rows" - }, - { - "schema": { - "type": "integer", - "minimum": 1 - }, - "in": "query", - "name": "limit", - "description": "Limit in rows" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "sortArrJson", - "description": "Used for multiple sort queries" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "filterArrJson", - "description": "Used for multiple filter queries" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "description": "Create a new nested relations row" - }, - "delete": { - "summary": "Delete Nested Relations Row", - "operationId": "db-table-row-nested-remove", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "vo3x8xf3j2xlb" - }, - "example": "The relation data has been deleted successfully" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "The relation data has been deleted successfully" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Row"], - "description": "Delete a new nested relations row", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/{rowId}/{relationType}/{columnName}/exclude": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "example": "1" - }, - "name": "rowId", - "in": "path", - "required": true, - "description": "Unique Row ID" - }, - { - "schema": { - "type": "string", - "enum": ["mm", "hm", "bt"] - }, - "name": "relationType", - "in": "path", - "required": true - }, - { - "schema": { - "type": "string" - }, - "name": "columnName", - "in": "path", - "required": true - } - ], - "get": { - "summary": "Referenced Table Rows Excluding Current Record's Children / Parent", - "operationId": "db-table-row-nested-children-excluded-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": {} - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Row"], - "parameters": [ - { - "schema": { - "type": "integer", - "minimum": 1 - }, - "in": "query", - "name": "limit" - }, - { - "schema": { - "type": "integer", - "minimum": 0 - }, - "in": "query", - "name": "offset" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "description": "Get the table rows but exculding the current record's children and parent" - } - }, - "/api/v1/db/public/shared-view/{sharedViewUuid}/group/{columnId}": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "24a6d0bb-e45d-4b1a-bfef-f492d870de9f" - }, - "name": "sharedViewUuid", - "in": "path", - "required": true, - "description": "Shared View UUID" - }, - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "cl_8iw2o4ejzvdyna", - "type": "string" - }, - "name": "columnId", - "in": "path", - "required": true, - "description": "Unique Column ID" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "xc-password", - "description": "Shared view password" - } - ], - "get": { - "summary": "List Shared View Grouped Data", - "operationId": "public-grouped-data-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "x-stoplight": { - "id": "bldcv1pwuri5s" - }, - "type": "object", - "properties": { - "key": { - "type": "string", - "x-stoplight": { - "id": "n0ujmkbyhgsxo" - }, - "description": "The Grouped Key" - }, - "value": { - "type": "object", - "x-stoplight": { - "id": "0xsi3jvwn7duo" - }, - "description": "the paginated result of the given key", - "required": ["list", "pageInfo"], - "properties": { - "list": { - "type": "array", - "x-stoplight": { - "id": "jw8dmo16txbjv" - }, - "description": "List of the target data", - "items": { - "x-stoplight": { - "id": "xcu8vxmf5ygyi" - }, - "type": "object" - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated", - "x-stoplight": { - "id": "1gsbgwi9bg8s5" - }, - "description": "Paginated Info" - } - } - } - }, - "required": ["key", "value"] - } - }, - "examples": { - "Example 1": { - "value": [ - { - "key": "a", - "value": { - "list": [ - { - "Id": 2, - "Title": "foo", - "s": "a" - } - ], - "pageInfo": { - "totalRows": 1, - "page": 1, - "pageSize": 25, - "isFirstPage": true, - "isLastPage": true - } - } - }, - { - "key": "b", - "value": { - "list": [ - { - "Id": 3, - "Title": "bar", - "s": "b" - } - ], - "pageInfo": { - "totalRows": 1, - "page": 1, - "pageSize": 25, - "isFirstPage": true, - "isLastPage": true - } - } - }, - { - "key": null, - "value": { - "list": [ - { - "Id": 1, - "Title": "baz", - "s": null - } - ], - "pageInfo": { - "totalRows": 1, - "page": 1, - "pageSize": 25, - "isFirstPage": true, - "isLastPage": true - } - } - } - ] - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Public"], - "parameters": [ - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "fields", - "description": "Which fields to be shown" - }, - { - "schema": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "type": "string" - } - ] - }, - "in": "query", - "name": "sort", - "description": "The result will be sorted based on `sort` query" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where", - "description": "Extra filtering" - }, - { - "schema": { - "type": "integer", - "minimum": 0 - }, - "in": "query", - "name": "offset", - "description": "Offset in rows" - }, - { - "schema": { - "type": "integer", - "minimum": 1 - }, - "in": "query", - "name": "limit", - "description": "Limit in rows" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "sortArrJson", - "description": "Used for multiple sort queries" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "filterArrJson", - "description": "Used for multiple filter queries" - } - ], - "description": "List Shared View Grouped Data" - } - }, - "/api/v1/db/public/shared-view/{sharedViewUuid}/rows": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "24a6d0bb-e45d-4b1a-bfef-f492d870de9f" - }, - "name": "sharedViewUuid", - "in": "path", - "required": true, - "description": "Shared View UUID" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "xc-password", - "description": "Shared view password" - } - ], - "get": { - "summary": "List Shared View Rows", - "operationId": "public-data-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SharedViewList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:46:31", - "fk_model_id": "md_mhs9z4r2ak98x0", - "id": "vw_lg052cnc1c26kf", - "is_default": 1, - "lock_type": "collaborative", - "meta": {}, - "order": 1, - "password": null, - "project_id": "p_xm3thidrblw4n7", - "show": 1, - "show_system_fields": null, - "title": "Sheet-1", - "type": 3, - "updated_at": "2023-03-02 17:46:31", - "uuid": null, - "view": { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:46:31", - "fk_view_id": "vw_lg052cnc1c26kf", - "meta": null, - "project_id": "p_xm3thidrblw4n7", - "row_height": null, - "updated_at": "2023-03-02 17:46:31", - "uuid": null - } - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Public"], - "parameters": [ - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "fields", - "description": "Which fields to be shown" - }, - { - "schema": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "type": "string" - } - ] - }, - "in": "query", - "name": "sort", - "description": "The result will be sorted based on `sort` query" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where", - "description": "Extra filtering" - }, - { - "schema": { - "type": "integer", - "minimum": 0 - }, - "in": "query", - "name": "offset", - "description": "Offset in rows" - }, - { - "schema": { - "type": "integer", - "minimum": 1 - }, - "in": "query", - "name": "limit", - "description": "Limit in rows" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "sortArrJson", - "description": "Used for multiple sort queries" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "filterArrJson", - "description": "Used for multiple filter queries" - } - ], - "description": "List all shared view rows" - }, - "post": { - "summary": "Create Share View Row", - "operationId": "public-data-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "examples": { - "Example 1": { - "value": { - "Id": 1, - "col1": "foo", - "col2": "bar", - "CreatedAt": "2023-03-11T08:48:25.598Z", - "UpdatedAt": "2023-03-11T08:48:25.598Z" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "multipart/form-data": {} - }, - "description": "" - }, - "tags": ["Public"], - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "xc-password", - "description": "Shared view password" - } - ], - "description": "Create a new row for the target shared view" - } - }, - "/api/v1/db/public/shared-view/{sharedViewUuid}/rows/{rowId}/{relationType}/{columnName}": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "24a6d0bb-e45d-4b1a-bfef-f492d870de9f" - }, - "name": "sharedViewUuid", - "in": "path", - "required": true, - "description": "Shared View UUID" - }, - { - "schema": { - "example": "1" - }, - "name": "rowId", - "in": "path", - "required": true, - "description": "Unique Row ID" - }, - { - "schema": { - "type": "string", - "enum": ["mm", "hm", "bt"] - }, - "name": "relationType", - "in": "path", - "required": true, - "description": "Relation Type" - }, - { - "schema": { - "type": "string" - }, - "name": "columnName", - "in": "path", - "required": true, - "description": "Column Name" - } - ], - "get": { - "summary": "List Nested List Data", - "operationId": "public-data-nested-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "list": { - "type": "array", - "x-stoplight": { - "id": "gvblksjzjfyg7" - }, - "description": "List of data objects", - "items": { - "x-stoplight": { - "id": "8assgoc1vtcs9" - }, - "type": "object" - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated", - "x-stoplight": { - "id": "if546w1yuo6fw" - }, - "description": "Paginated info" - } - }, - "required": ["list", "pageInfo"] - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "Id": 1, - "Title": "foo", - "CreatedAt": "2023-03-11T08:41:41.356Z", - "UpdatedAt": "2023-03-11T08:41:41.356Z" - }, - { - "Id": 2, - "Title": "bar", - "CreatedAt": "2023-03-11T08:41:45.330Z", - "UpdatedAt": "2023-03-11T08:41:45.330Z" - }, - { - "Id": 3, - "Title": "baz", - "CreatedAt": "2023-03-11T08:48:25.598Z", - "UpdatedAt": "2023-03-11T08:48:25.598Z" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "pageSize": 1, - "sort": "string", - "totalRows": 3 - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Public"], - "parameters": [ - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "fields", - "description": "Which fields to be shown" - }, - { - "schema": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "type": "string" - } - ] - }, - "in": "query", - "name": "sort", - "description": "The result will be sorted based on `sort` query" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where", - "description": "Extra filtering" - }, - { - "schema": { - "type": "integer", - "minimum": 0 - }, - "in": "query", - "name": "offset", - "description": "Offset in rows" - }, - { - "schema": { - "type": "integer", - "minimum": 1 - }, - "in": "query", - "name": "limit", - "description": "Limit in rows" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "sortArrJson", - "description": "Used for multiple sort queries" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "filterArrJson", - "description": "Used for multiple filter queries" - } - ], - "description": "List all nested list data in a given shared view" - } - }, - "/api/v1/db/public/shared-view/{sharedViewUuid}/rows/export/{type}": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "76d44b86-bc65-4500-8956-ab512c80ab25" - }, - "name": "sharedViewUuid", - "in": "path", - "required": true, - "description": "Shared View UUID" - }, - { - "schema": { - "type": "string", - "enum": ["csv", "excel"], - "example": "csv" - }, - "name": "type", - "in": "path", - "required": true, - "description": "Export Type" - } - ], - "get": { - "summary": "Export Rows in Share View", - "operationId": "public-csv-export", - "description": "Export all rows in Share View in a CSV / Excel Format", - "wrapped": true, - "responses": { - "200": { - "description": "OK", - "content": { - "application/octet-stream": { - "schema": {} - } - }, - "headers": { - "nc-export-offset": { - "schema": { - "type": "integer" - }, - "description": "The starting offset of the next set of rows" - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Public"] - } - }, - "/api/v1/db/public/shared-view/{sharedViewUuid}/nested/{columnName}": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "24a6d0bb-e45d-4b1a-bfef-f492d870de9f" - }, - "name": "sharedViewUuid", - "in": "path", - "required": true, - "description": "Shared View UUID" - }, - { - "schema": { - "type": "string" - }, - "name": "columnName", - "in": "path", - "required": true, - "description": "Column Name" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "xc-password", - "description": "Shared view password" - } - ], - "get": { - "summary": "List Nested Data Relation", - "operationId": "public-data-relation-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": {} - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "parameters": [ - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "fields", - "description": "Which fields to be shown" - }, - { - "schema": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "type": "string" - } - ] - }, - "in": "query", - "name": "sort", - "description": "The result will be sorted based on `sort` query" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where", - "description": "Extra filtering" - }, - { - "schema": { - "type": "integer", - "minimum": 0 - }, - "in": "query", - "name": "offset", - "description": "Offset in rows" - }, - { - "schema": { - "type": "integer", - "minimum": 1 - }, - "in": "query", - "name": "limit", - "description": "Limit in rows" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "sortArrJson", - "description": "Used for multiple sort queries" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "filterArrJson", - "description": "Used for multiple filter queries" - } - ], - "tags": ["Public"], - "description": "List Nested Data Relation" - } - }, - "/api/v1/db/public/shared-base/{sharedBaseUuid}/meta": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "24a6d0bb-e45d-4b1a-bfef-f492d870de9f" - }, - "name": "sharedBaseUuid", - "in": "path", - "required": true, - "description": "Shared Base UUID" - } - ], - "get": { - "summary": "Get Share Base Meta", - "operationId": "public-shared-base-get", - "description": "Get Share Base Meta", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "project_id": { - "type": "string", - "description": "Project ID" - } - } - }, - "examples": { - "Example 1": { - "value": { - "project_id": "p_63b4q0qengen1x" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Public"] - } - }, - "/api/v1/db/public/shared-view/{sharedViewUuid}/meta": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "24a6d0bb-e45d-4b1a-bfef-f492d870de9f" - }, - "name": "sharedViewUuid", - "in": "path", - "required": true, - "description": "Shared View UUID" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "xc-password", - "description": "Shared view password" - } - ], - "get": { - "summary": "Get Share View Meta", - "operationId": "public-shared-view-meta-get", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/View" - }, - { - "type": "object", - "properties": { - "relatedMetas": {}, - "client": { - "type": "string" - }, - "base_id": { - "type": "string" - }, - "columns": { - "allOf": [ - { - "anyOf": [ - { - "$ref": "#/components/schemas/GridColumn" - }, - { - "$ref": "#/components/schemas/FormColumn" - }, - { - "$ref": "#/components/schemas/GalleryColumn" - } - ] - }, - { - "$ref": "#/components/schemas/Column" - } - ] - }, - "model": { - "$ref": "#/components/schemas/Table" - } - } - }, - { - "type": "object", - "properties": { - "view": { - "anyOf": [ - { - "$ref": "#/components/schemas/Form" - }, - { - "$ref": "#/components/schemas/Grid" - }, - { - "$ref": "#/components/schemas/Gallery" - } - ] - } - } - } - ] - } - }, - "application/xml": { - "schema": {} - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Public"], - "description": "Get Share View Meta" - } - }, - "/api/v1/db/meta/audits/comments": { - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "get": { - "summary": "List Comments in Audit", - "operationId": "utils-comment-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "list": { - "x-stoplight": { - "id": "5zto1xohsngbu" - }, - "type": "array", - "items": { - "$ref": "#/components/schemas/Audit", - "x-stoplight": { - "id": "d22zkup0c0l80" - } - } - } - }, - "required": ["list"] - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "id": "adt_3sii7erfwrlegb", - "user": "w@nocodb.com", - "ip": null, - "base_id": null, - "project_id": "p_63b4q0qengen1x", - "fk_model_id": "md_5mipbdg6ketmv8", - "row_id": "1", - "op_type": "COMMENT", - "op_sub_type": null, - "status": null, - "description": "bar", - "details": null, - "created_at": "2023-03-13T09:39:14.225Z", - "updated_at": "2023-03-13T09:39:14.225Z" - }, - { - "id": "adt_fezs668qbxj8gc", - "user": "w@nocodb.com", - "ip": null, - "base_id": null, - "project_id": "p_63b4q0qengen1x", - "fk_model_id": "md_5mipbdg6ketmv8", - "row_id": "1", - "op_type": "COMMENT", - "op_sub_type": null, - "status": null, - "description": "foo", - "details": null, - "created_at": "2023-03-13T09:39:13.321Z", - "updated_at": "2023-03-13T09:39:13.321Z" - } - ] - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "List all comments", - "parameters": [ - { - "schema": { - "type": "string", - "example": "10" - }, - "in": "query", - "name": "row_id", - "required": true, - "description": "Row ID" - }, - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "md_c6csq89tl37jm5" - }, - "in": "query", - "name": "fk_model_id", - "required": true, - "description": "Foreign Key to Model" - }, - { - "schema": { - "type": "boolean", - "example": true - }, - "in": "query", - "name": "comments_only", - "description": "Is showing comments only?" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["Utils"] - }, - "post": { - "summary": "Comment Rows", - "operationId": "utils-comment-row", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Audit" - }, - "examples": { - "Example 1": { - "value": { - "user": "w@nocodb.com", - "row_id": "1", - "fk_model_id": "md_5mipbdg6ketmv8", - "op_type": "COMMENT", - "description": "qq", - "project_id": "p_63b4q0qengen1x", - "id": "adt_vx58jpp0loo8qy" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CommentReq" - }, - "examples": { - "Example 1": { - "value": { - "description": "This is the comment for the row", - "fk_model_id": "md_ehn5izr99m7d45", - "row_id": "3" - } - } - } - } - } - }, - "tags": ["Utils"], - "description": "Create a new comment in a row. Logged in Audit.", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/audits/{auditId}/comment": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "adt_zlskd6rlf3liay" - }, - "name": "auditId", - "in": "path", - "required": true, - "description": "Audit ID" - }, - { - "name": "xc-auth", - "in": "header", - "required": false, - "schema": { - "type": "string" - }, - "description": "Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN." - } - ], - "patch": { - "summary": "Update Comment in Audit", - "operationId": "utils-comment-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number", - "example": 1 - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - } - }, - "tags": ["Utils"], - "description": "Update comment in Audit", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CommentUpdateReq" - }, - "examples": { - "Example 1": { - "value": { - "description": "This is the comment for the row" - } - } - } - } - } - } - } - }, - "/api/v1/db/meta/audits/comments/count": { - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "get": { - "summary": "Count Comments", - "operationId": "utils-comment-count", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "x-stoplight": { - "id": "ziwcy4va5r1ao" - }, - "type": "object", - "properties": { - "count": { - "type": "string", - "x-stoplight": { - "id": "5r91gkxmaiyv4" - }, - "description": "The number of comments", - "example": "4" - }, - "row_id": { - "type": "string", - "x-stoplight": { - "id": "08sgorhq172sm" - }, - "description": "Row ID", - "example": "1" - } - }, - "required": ["count", "row_id"] - } - }, - "examples": { - "Example 1": { - "value": [ - { - "count": "4", - "row_id": "1" - } - ] - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Return the number of comments in the given query.", - "parameters": [ - { - "in": "query", - "name": "ids", - "required": true, - "description": "Comment IDs" - }, - { - "schema": { - "$ref": "#/components/schemas/Id" - }, - "in": "query", - "name": "fk_model_id", - "required": true, - "description": "Foreign Key to Model" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["Utils"] - } - }, - "/api/v1/db/meta/projects/{projectId}/audits": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - } - ], - "get": { - "summary": "List Audits in Project", - "operationId": "project-audit-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "list": { - "type": "array", - "uniqueItems": true, - "minItems": 1, - "items": { - "$ref": "#/components/schemas/Audit" - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated" - } - }, - "required": ["list", "pageInfo"] - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "List all audit data in the given project", - "parameters": [ - { - "schema": { - "type": "integer", - "minimum": 0 - }, - "in": "query", - "name": "offset" - }, - { - "schema": { - "type": "integer", - "maximum": 1 - }, - "in": "query", - "name": "limit" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["Project"] - } - }, - "/api/v1/db/meta/audits/rows/{rowId}/update": { - "parameters": [ - { - "schema": { - "example": "1" - }, - "name": "rowId", - "in": "path", - "required": true, - "description": "Unique Row ID" - } - ], - "post": { - "summary": "Update Audit Row", - "operationId": "utils-audit-row-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Audit" - }, - "examples": { - "Example 1": { - "value": { - "user": "w@nocodb.com", - "row_id": "1", - "fk_model_id": "md_5mipbdg6ketmv8", - "op_type": "COMMENT", - "description": "Table Sheet-1 : field Column A got changed from foo to bar", - "project_id": "p_63b4q0qengen1x", - "id": "adt_vx58jpp0loo8qy" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Utils"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AuditRowUpdateReq" - }, - "examples": { - "Example 1": { - "value": { - "column_name": "baz", - "fk_model_id": "md_ehn5izr99m7d45", - "row_id": "1", - "prev_value": "foo", - "value": "bar" - } - } - } - } - } - }, - "description": "Update Audit Row", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/tables/{tableId}/hooks": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "md_w9gpnaousnfss1", - "type": "string" - }, - "name": "tableId", - "in": "path", - "required": true, - "description": "Unique Table ID" - } - ], - "get": { - "summary": "List Table Hooks", - "operationId": "db-table-webhook-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HookList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "active": 0, - "async": 0, - "description": "This is my hook description", - "env": "all", - "event": "after", - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "string", - "notification": "{\"type\":\"URL\",\"payload\":{\"method\":\"POST\",\"body\":\"{{ json data }}\",\"headers\":[{}],\"parameters\":[{}],\"auth\":\"\",\"path\":\"http://example.com\"}}", - "null": null, - "operation": "insert", - "retries": 10, - "retry_interval": 60000, - "timeout": 60000, - "title": "My Webhook" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "List all hook records in the given Table", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["DB Table Webhook"] - }, - "post": { - "summary": "Create Table Hook", - "operationId": "db-table-webhook-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Hook" - }, - "examples": { - "Example 1": { - "value": { - "active": 0, - "async": 0, - "description": "This is my hook description", - "env": "all", - "event": "after", - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "string", - "notification": "{\"type\":\"URL\",\"payload\":{\"method\":\"POST\",\"body\":\"{{ json data }}\",\"headers\":[{}],\"parameters\":[{}],\"auth\":\"\",\"path\":\"http://example.com\"}}", - "null": null, - "operation": "insert", - "retries": 10, - "retry_interval": 60000, - "timeout": 60000, - "title": "My Webhook" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Create a hook in the given table", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HookReq" - }, - "examples": { - "Example 1": { - "value": { - "active": 0, - "async": 0, - "description": "This is my hook description", - "env": "all", - "event": "after", - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "string", - "notification": "{\"type\":\"URL\",\"payload\":{\"method\":\"POST\",\"body\":\"{{ json data }}\",\"headers\":[{}],\"parameters\":[{}],\"auth\":\"\",\"path\":\"http://example.com\"}}", - "null": null, - "operation": "insert", - "retries": 10, - "retry_interval": 60000, - "timeout": 60000, - "title": "My Webhook", - "condition": false - } - } - } - } - } - }, - "tags": ["DB Table Webhook"] - } - }, - "/api/v1/db/meta/tables/{tableId}/hooks/test": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "md_w9gpnaousnfss1", - "type": "string" - }, - "name": "tableId", - "in": "path", - "required": true, - "description": "Unique Table ID" - } - ], - "post": { - "summary": "Test Hook", - "operationId": "db-table-webhook-test", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "l5k90tzuvvv1g" - }, - "example": "The hook has been tested successfully" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "The hook has been tested successfully" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Webhook"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HookTestReq" - }, - "examples": { - "Example 1": { - "value": { - "hook": { - "active": 0, - "async": 0, - "description": "This is my hook description", - "env": "all", - "event": "after", - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "string", - "notification": "{\"type\":\"URL\",\"payload\":{\"method\":\"POST\",\"body\":\"{{ json data }}\",\"headers\":[{}],\"parameters\":[{}],\"auth\":\"\",\"path\":\"http://example.com\"}}", - "null": null, - "operation": "insert", - "retries": 10, - "retry_interval": 60000, - "timeout": 60000, - "title": "My Webhook" - }, - "payload": { - "data": { - "Id": 1, - "Title": "Sample Text", - "CreatedAt": "2023-03-03T10:03:06.484Z", - "UpdatedAt": "2023-03-03T10:03:06.484Z", - "attachment": [ - { - "url": "https://nocodb.com/dummy.png", - "title": "image.png", - "mimetype": "image/png", - "size": 0 - } - ], - "f": "Sample Output" - } - } - } - } - } - } - } - }, - "description": "Test the hook in the given Table", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/tables/{tableId}/hooks/samplePayload/{operation}/{version}": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "md_w9gpnaousnfss1", - "type": "string" - }, - "name": "tableId", - "in": "path", - "required": true, - "description": "Unique Table ID" - }, - { - "schema": { - "type": "string", - "enum": [ - "insert", - "update", - "delete", - "bulkInsert", - "bulkUpdate", - "bulkDelete" - ] - }, - "name": "operation", - "in": "path", - "required": true, - "description": "Hook Operation" - }, - { - "schema": { - "type": "string", - "enum": ["v1", "v2"] - }, - "name": "version", - "in": "path", - "required": true, - "description": "Hook Version" - } - ], - "get": { - "summary": "Get Sample Hook Payload", - "operationId": "db-table-webhook-sample-payload-get", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "data": { - "type": "object", - "x-stoplight": { - "id": "qifsikf69hqbl" - }, - "description": "Sample Payload Data" - } - } - }, - "examples": { - "Example 1": { - "value": { - "data": { - "Id": 1, - "Title": "Sample Text", - "CreatedAt": "2023-03-13T04:59:49.363Z", - "UpdatedAt": "2023-03-13T04:59:49.363Z" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Get the sample hook payload", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["DB Table Webhook"] - } - }, - "/api/v1/db/meta/hooks/{hookId}": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "hk_0063k4o1frnxbr" - }, - "name": "hookId", - "in": "path", - "required": true, - "description": "Unique Hook ID" - } - ], - "patch": { - "summary": "Update Hook", - "operationId": "db-table-webhook-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Hook" - }, - "examples": { - "Example 1": { - "value": { - "active": 0, - "async": 0, - "description": "This is my hook description", - "env": "all", - "event": "after", - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "string", - "notification": "{\"type\":\"URL\",\"payload\":{\"method\":\"POST\",\"body\":\"{{ json data }}\",\"headers\":[{}],\"parameters\":[{}],\"auth\":\"\",\"path\":\"http://example.com\"}}", - "null": null, - "operation": "insert", - "retries": 10, - "retry_interval": 60000, - "timeout": 60000, - "title": "My Webhook" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Webhook"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Hook" - }, - "examples": { - "Example 1": { - "value": { - "active": 0, - "async": 0, - "description": "This is my hook description", - "env": "all", - "event": "after", - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "string", - "notification": "{\"type\":\"URL\",\"payload\":{\"method\":\"POST\",\"body\":\"{{ json data }}\",\"headers\":[{}],\"parameters\":[{}],\"auth\":\"\",\"path\":\"http://example.com\"}}", - "null": null, - "operation": "insert", - "retries": 10, - "retry_interval": 60000, - "timeout": 60000, - "title": "My Webhook" - } - } - } - } - } - }, - "description": "Update the exsiting hook by its ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "delete": { - "summary": "Delete Hook", - "operationId": "db-table-webhook-delete", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "boolean" - }, - "examples": { - "Example 1": { - "value": true - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Webhook"], - "description": "Delete the exsiting hook by its ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/plugins": { - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "get": { - "summary": "List Plugins", - "operationId": "plugin-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "list": { - "type": "array", - "uniqueItems": true, - "minItems": 1, - "items": { - "$ref": "#/components/schemas/Plugin" - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "List all plugins", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["Plugin"] - } - }, - "/api/v1/db/meta/plugins/{pluginTitle}/status": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "pluginTitle", - "in": "path", - "required": true, - "description": "Plugin Title" - } - ], - "get": { - "summary": "Get Plugin Status", - "operationId": "plugin-status", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "boolean" - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Check plugin is active or not", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["Plugin"], - "x-internal": false - } - }, - "/api/v1/db/meta/plugins/test": { - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "post": { - "summary": "Test Plugin", - "operationId": "plugin-test", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": {} - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Test if the plugin is working with the given configurations", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["Plugin"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PluginTestReq" - }, - "examples": { - "Example 1": { - "value": { - "title": "Plugin Foo", - "input": "{\"bucket\":\"my-bucket\",\"region\":\"us-west-004\",\"access_key\":\"redacted\",\"access_secret\":\"redacted\"}", - "category": "Email" - } - } - } - } - } - } - } - }, - "/api/v1/db/meta/plugins/{pluginId}": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "pluginId", - "in": "path", - "required": true, - "description": "Plugin ID" - } - ], - "patch": { - "summary": "Update Plugin", - "operationId": "plugin-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": {} - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Plugin"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PluginReq" - } - } - } - }, - "description": "Update the plugin data by ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "x-internal": false - }, - "get": { - "summary": "Get Plugin", - "operationId": "plugin-read", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Plugin" - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Plugin"], - "description": "Get the plugin data by ID", - "x-internal": false - } - }, - "/api/v1/db/meta/connection/test": { - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "post": { - "summary": "Test DB Connection", - "operationId": "utils-test-connection", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "code": { - "type": "number" - }, - "message": { - "type": "string" - }, - "data": { - "type": "object", - "x-stoplight": { - "id": "6orbk04w97ien" - } - } - } - }, - "examples": { - "Example 1": { - "value": { - "code": 0, - "message": "", - "data": {} - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Utils"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "x-examples": { - "Example 1": { - "client": "mysql2", - "connection": { - "host": "localhost", - "port": "3306", - "user": "root", - "password": "password", - "database": null - } - } - }, - "properties": { - "client": { - "description": "DB Type", - "enum": [ - "mssql", - "mysql", - "mysql2", - "oracledb", - "pg", - "snowflake", - "sqlite3" - ], - "example": "mysql2", - "type": "string" - }, - "connection": { - "type": "object", - "properties": { - "host": { - "type": "string" - }, - "port": { - "type": "string" - }, - "user": { - "type": "string" - }, - "password": { - "type": "string" - }, - "database": { - "$ref": "#/components/schemas/StringOrNull" - } - } - } - } - }, - "examples": { - "Example 1": { - "value": { - "client": "mysql2", - "connection": { - "host": "localhost", - "port": "3306", - "user": "root", - "password": "password", - "database": null - } - } - } - } - } - } - }, - "description": "Test the DB Connection", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/url_to_config": { - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "post": { - "summary": "Convert JDBC URL to Config", - "operationId": "utils-url-to-config", - "tags": ["Utils"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "url": { - "type": "string", - "x-stoplight": { - "id": "fgdbmcjjtkky5" - }, - "description": "JDBC URL", - "example": "jdbc:mysql://username:password@localhost:3306/sakila" - } - } - }, - "examples": { - "Example 1": { - "value": { - "url": "jdbc:mysql://username:password@localhost:3306/sakila" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "x-examples": { - "Example 1": { - "client": "mysql2", - "connection": { - "user": "username", - "password": "password", - "database": "sakila", - "host": "localhost", - "port": "3306" - } - } - }, - "properties": { - "client": { - "description": "DB Type", - "enum": [ - "mssql", - "mysql", - "mysql2", - "oracledb", - "pg", - "snowflake", - "sqlite3" - ], - "example": "mysql2", - "type": "string" - }, - "connection": { - "type": "object", - "description": "Connection Config", - "properties": { - "user": { - "type": "string", - "description": "DB User" - }, - "password": { - "type": "string", - "description": "DB Password" - }, - "database": { - "type": "string", - "description": "DB Name" - }, - "host": { - "type": "string", - "description": "DB Host" - }, - "port": { - "type": "string", - "description": "DB Host" - } - } - } - } - }, - "examples": { - "Example 1": { - "value": { - "client": "mysql2", - "connection": { - "user": "username", - "password": "password", - "database": "sakila", - "host": "localhost", - "port": "3306" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Extract XC URL From JDBC and parse to connection config", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/nocodb/info": { - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "get": { - "summary": "Get App Info", - "operationId": "utils-app-info", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "x-examples": { - "Example 1": { - "authType": "jwt", - "projectHasAdmin": true, - "firstUser": false, - "type": "rest", - "googleAuthEnabled": false, - "githubAuthEnabled": false, - "oneClick": false, - "connectToExternalDB": true, - "version": "0.105.3", - "defaultLimit": 25, - "ncMin": false, - "teleEnabled": false, - "auditEnabled": true, - "ncSiteUrl": "http://localhost:8080", - "ee": false, - "ncAttachmentFieldSize": 20971520, - "ncMaxAttachmentsAllowed": 10 - } - }, - "properties": { - "authType": { - "type": "string" - }, - "projectHasAdmin": { - "type": "boolean" - }, - "firstUser": { - "type": "boolean" - }, - "type": { - "type": "string" - }, - "googleAuthEnabled": { - "type": "boolean" - }, - "githubAuthEnabled": { - "type": "boolean" - }, - "oneClick": { - "type": "boolean" - }, - "connectToExternalDB": { - "type": "boolean" - }, - "version": { - "type": "string" - }, - "defaultLimit": { - "type": "number" - }, - "ncMin": { - "type": "boolean" - }, - "teleEnabled": { - "type": "boolean" - }, - "auditEnabled": { - "type": "boolean" - }, - "ncSiteUrl": { - "type": "string" - }, - "ee": { - "type": "boolean" - }, - "ncAttachmentFieldSize": { - "type": "number" - }, - "ncMaxAttachmentsAllowed": { - "type": "number" - }, - "isCloud": { - "type": "boolean", - "x-stoplight": { - "id": "bstdkpky2131f" - } - }, - "automationLogLevel": { - "type": "string", - "x-stoplight": { - "id": "uc3vaotye2eu8" - }, - "enum": ["OFF", "ERROR", "ALL"], - "example": "OFF" - } - } - }, - "examples": { - "Example 1": { - "value": { - "authType": "jwt", - "projectHasAdmin": true, - "firstUser": false, - "type": "rest", - "googleAuthEnabled": false, - "githubAuthEnabled": false, - "oneClick": false, - "connectToExternalDB": true, - "version": "0.105.3", - "defaultLimit": 25, - "ncMin": false, - "teleEnabled": false, - "auditEnabled": true, - "ncSiteUrl": "http://localhost:8080", - "ee": false, - "ncAttachmentFieldSize": 20971520, - "ncMaxAttachmentsAllowed": 10, - "isCloud": false, - "automationLogLevel": "OFF" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Utils"], - "description": "Get the application info such as authType, defaultLimit, version and etc.", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/axiosRequestMake": { - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "post": { - "summary": "Axios Request", - "operationId": "utils-axios-request-make", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {} - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Generic Axios Call", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object" - } - } - } - }, - "tags": ["Utils"], - "x-internal": true, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/version": { - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "get": { - "summary": "Get App Version", - "operationId": "utils-app-version", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "x-examples": { - "Example 1": { - "currentVersion": "0.105.3", - "releaseVersion": "0.105.3" - } - }, - "properties": { - "currentVersion": { - "type": "string", - "description": "Current NocoDB Version", - "example": "0.104.0" - }, - "releaseVersion": { - "type": "string", - "description": "Latest Release Version", - "example": "0.105.3" - } - } - }, - "examples": { - "Example 1": { - "value": { - "currentVersion": "0.104.0", - "releaseVersion": "0.105.3" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Utils"], - "description": "Get the application version", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/health": { - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "get": { - "summary": "Get Application Health Status", - "operationId": "utils-app-health", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "x-examples": { - "Example 1": { - "message": "OK", - "timestamp": 1678702175755, - "uptime": 1618.996877834 - } - }, - "properties": { - "message": { - "type": "string", - "example": "OK" - }, - "timestamp": { - "type": "string", - "example": "1678702175755" - }, - "uptime": { - "type": "string", - "example": "1618.996877834" - } - } - }, - "examples": { - "Example 1": { - "value": { - "message": "OK", - "timestamp": 1678702175755, - "uptime": 1618.996877834 - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Utils"], - "description": "Get Application Health Status", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/aggregated-meta-info": { - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "get": { - "summary": "Get Aggregated Meta Info", - "operationId": "utils-aggregated-meta-info", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "projectCount": { - "type": "integer" - }, - "projects": { - "type": "array", - "items": { - "type": "object", - "properties": { - "tableCount": { - "type": "object", - "properties": { - "table": { - "type": "integer", - "description": "Table Count" - }, - "view": { - "type": "integer", - "description": "View Count" - } - } - }, - "external": { - "type": "boolean", - "description": "External Project", - "default": false - }, - "viewCount": { - "type": "object", - "properties": { - "formCount": { - "type": "integer", - "description": "Form Count" - }, - "gridCount": { - "type": "integer", - "description": "Grid Count" - }, - "galleryCount": { - "type": "integer", - "description": "Gallery Count" - }, - "kanbanCount": { - "type": "integer", - "description": "Kanban Count" - }, - "total": { - "type": "integer", - "description": "Total View Count" - }, - "sharedFormCount": { - "type": "integer", - "description": "Shared Form Count" - }, - "sharedGridCount": { - "type": "integer", - "description": "Shared Grid Count" - }, - "sharedGalleryCount": { - "type": "integer", - "description": "Shared Gallery Count" - }, - "sharedKanbanCount": { - "type": "integer", - "description": "Shared Kanban Count" - }, - "sharedTotal": { - "type": "integer", - "description": "Shared Total View Count" - }, - "sharedLockedCount": { - "type": "integer", - "description": "Shared Locked View Count" - } - } - }, - "webhookCount": { - "type": "integer", - "description": "Webhook Count" - }, - "filterCount": { - "type": "integer", - "description": "Filter Count" - }, - "sortCount": { - "type": "integer", - "description": "Sort Count" - }, - "rowCount": { - "type": "array", - "items": { - "type": "object", - "properties": { - "TotalRecords": { - "type": "string" - } - } - }, - "description": "Row Count" - }, - "userCount": { - "type": "integer", - "description": "Total project user Count" - } - } - } - }, - "userCount": { - "type": "integer", - "description": "Total user Count" - }, - "sharedBaseCount": { - "type": "integer", - "description": "Total shared base Count" - } - }, - "x-examples": { - "Example 1": { - "projectCount": 1, - "projects": [ - { - "tableCount": { - "table": 3, - "view": 0 - }, - "external": false, - "viewCount": { - "formCount": 0, - "gridCount": 3, - "galleryCount": 0, - "kanbanCount": 0, - "total": 3, - "sharedFormCount": 0, - "sharedGridCount": 0, - "sharedGalleryCount": 0, - "sharedKanbanCount": 0, - "sharedTotal": 0, - "sharedLockedCount": 0 - }, - "webhookCount": 0, - "filterCount": 0, - "sortCount": 0, - "rowCount": [ - { - "TotalRecords": "76" - } - ], - "userCount": 1 - } - ], - "userCount": 1, - "sharedBaseCount": 0 - } - } - }, - "examples": { - "example-1": { - "value": { - "projectCount": 1, - "projects": [ - { - "tableCount": { - "table": 3, - "view": 0 - }, - "external": false, - "viewCount": { - "formCount": 0, - "gridCount": 3, - "galleryCount": 0, - "kanbanCount": 0, - "total": 3, - "sharedFormCount": 0, - "sharedGridCount": 0, - "sharedGalleryCount": 0, - "sharedKanbanCount": 0, - "sharedTotal": 0, - "sharedLockedCount": 0 - }, - "webhookCount": 0, - "filterCount": 0, - "sortCount": 0, - "rowCount": [ - { - "TotalRecords": "76" - } - ], - "userCount": 1 - } - ], - "userCount": 1, - "sharedBaseCount": 0 - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Utils"], - "description": "Get Aggregated Meta Info such as tableCount, dbViewCount, viewCount and etc.", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/cache": { - "get": { - "summary": "Get Cache", - "tags": ["Utils"], - "responses": {}, - "operationId": "utils-cache-get", - "description": "Get All K/V pairs in NocoCache", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "delete": { - "summary": "Delete Cache", - "operationId": "utils-cache-delete", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "boolean" - }, - "examples": { - "Example 1": { - "value": true - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Delete All K/V pairs in NocoCache", - "tags": ["Utils"], - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "/api/v1/db/meta/projects/{projectId}/api-tokens": { - "get": { - "summary": "List API Tokens in Project", - "tags": ["API Token"], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiTokenList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "id": "1", - "fk_user_id": "us_b3xo2i44nx5y9l", - "description": "This API Token is for ABC application", - "token": "DYh540o8hbWpUGdarekECKLdN5OhlgCUWutVJYX2" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "operationId": "api-token-list", - "description": "List API Tokens in the given project", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "post": { - "summary": "Create API Token", - "operationId": "api-token-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiToken" - }, - "examples": { - "Example 1": { - "value": { - "id": "1", - "fk_user_id": "us_b3xo2i44nx5y9l", - "description": "This API Token is for ABC application", - "token": "DYh540o8hbWpUGdarekECKLdN5OhlgCUWutVJYX2" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiTokenReq" - }, - "examples": { - "Example 1": { - "value": { - "description": "This API token is for ABC application" - } - } - } - } - }, - "description": "" - }, - "tags": ["API Token"], - "description": "Create API Token in a project", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - } - ] - }, - "/api/v1/db/meta/projects/{projectId}/api-tokens/{token}": { - "delete": { - "summary": "Delete API Token", - "operationId": "api-token-delete", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number", - "example": 1 - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["API Token"], - "description": "Delete the given API Token in project", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - }, - { - "schema": { - "type": "string", - "example": "DYh540o8hbWpUGdarekECKLdN5OhlgCUWutVJYX2" - }, - "name": "token", - "in": "path", - "required": true, - "description": "API Token" - } - ] - }, - "/api/v1/db/storage/upload": { - "post": { - "summary": "Attachment Upload", - "operationId": "storage-upload", - "responses": {}, - "tags": ["Storage"], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "$ref": "#/components/schemas/AttachmentReq" - }, - "examples": { - "Example 1": { - "value": { - "mimetype": "image/jpeg", - "path": "download/noco/jango_fett/Table1/attachment/uVbjPVQxC_SSfs8Ctx.jpg", - "size": 13052, - "title": "22bc-kavypmq4869759 (1).jpg" - } - } - } - } - }, - "description": "" - }, - "parameters": [ - { - "schema": { - "type": "string", - "example": "download/noco/jango_fett/Table1/attachment/uVbjPVQxC_SSfs8Ctx.jpg" - }, - "name": "path", - "in": "query", - "required": true, - "description": "Target File Path" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "description": "Upload attachment" - } - }, - "/api/v1/db/storage/upload-by-url": { - "post": { - "summary": "Attachment Upload by URL", - "operationId": "storage-upload-by-url", - "responses": {}, - "tags": ["Storage"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AttachmentReq" - } - }, - "examples": {} - } - } - }, - "parameters": [ - { - "schema": { - "type": "string", - "example": "download/noco/jango_fett/Table1/attachment/c7z_UF8sZBgJUxMjpN.jpg" - }, - "name": "path", - "in": "query", - "description": "Target File Path", - "required": true - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "description": "Upload attachment by URL. Used in Airtable Migration." - } - }, - "/api/v1/db/meta/projects/{projectId}/users/{userId}/resend-invite": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - }, - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "us_b3xo2i44nx5y9l" - }, - "name": "userId", - "in": "path", - "required": true, - "description": "Unique User ID" - } - ], - "post": { - "summary": "Resend User Invitation", - "operationId": "auth-project-user-resend-invite", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "m570oh5j3afjt" - }, - "description": "Success Message", - "example": "The invitation has been sent to the user" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "The invitation has been sent to the user" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Auth"], - "description": "Resend Invitation to a specific user", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - } - }, - "components": { - "schemas": { - "ApiToken": { - "description": "Model for API Token", - "examples": [ - { - "id": "1", - "fk_user_id": "us_b3xo2i44nx5y9l", - "description": "This API Token is for ABC application", - "token": "DYh540o8hbWpUGdarekECKLdN5OhlgCUWutVJYX2" - } - ], - "title": "API Token Model", - "type": "object", - "properties": { - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique API Token ID" - }, - "fk_user_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to User" - }, - "description": { - "type": "string", - "description": "API Token Description", - "example": "This API Token is for ABC application" - }, - "token": { - "type": "string", - "description": "API Token", - "example": "DYh540o8hbWpUGdarekECKLdN5OhlgCUWutVJYX2" - } - }, - "x-stoplight": { - "id": "95rfb0httdmw0" - } - }, - "ApiTokenReq": { - "description": "Model for API Token Request", - "examples": [ - { - "description": "This API token is for ABC application" - } - ], - "title": "API Token Request Model", - "type": "object", - "properties": { - "description": { - "description": "Description of the API token", - "maxLength": 255, - "type": "string", - "example": "This API Token is for ABC application" - } - }, - "x-stoplight": { - "id": "h3g2houpa6y9y" - } - }, - "ApiTokenList": { - "description": "Model for API Token List", - "x-stoplight": { - "id": "35b7cvjplxmfm" - }, - "examples": [ - { - "list": [ - { - "id": "1", - "fk_user_id": "us_b3xo2i44nx5y9l", - "description": "This API Token is for ABC application", - "token": "DYh540o8hbWpUGdarekECKLdN5OhlgCUWutVJYX2" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - ], - "title": "API Token List Model", - "type": "object", - "properties": { - "list": { - "type": "array", - "example": [ - { - "list": [ - { - "id": "1", - "fk_user_id": "us_b3xo2i44nx5y9l", - "description": "This API Token is for ABC application", - "token": "DYh540o8hbWpUGdarekECKLdN5OhlgCUWutVJYX2" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - ], - "x-stoplight": { - "id": "c7xu43yjgyjww" - }, - "description": "List of api token objects", - "items": { - "$ref": "#/components/schemas/ApiToken", - "x-stoplight": { - "id": "5ih4l0ix2tr5q" - } - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated", - "x-stoplight": { - "id": "0w8ktfnx3pusz" - }, - "description": "Model for Paginated" - } - }, - "required": ["list", "pageInfo"] - }, - "Attachment": { - "description": "Model for Attachment", - "examples": [ - { - "data": null, - "mimetype": "image/jpeg", - "path": "download/noco/jango_fett/Table1/attachment/c7z_UF8sZBgJUxMjpN.jpg", - "size": 12345, - "title": "kavypmq4869759.jpg" - } - ], - "title": "Attachment Model", - "type": "object", - "properties": { - "data": { - "description": "Data for uploading" - }, - "mimetype": { - "type": "string", - "description": "The mimetype of the attachment" - }, - "path": { - "type": "string", - "description": "File Path" - }, - "size": { - "type": "number", - "description": "Attachment Size" - }, - "title": { - "type": "string", - "description": "The title of the attachment. Used in UI." - }, - "url": { - "type": "string", - "description": "Attachment URL" - } - }, - "x-stoplight": { - "id": "pbx8hqgwdz7lw" - } - }, - "AttachmentReq": { - "description": "Model for Attachment Request", - "type": "object", - "x-examples": { - "Example 1": { - "mimetype": "image/jpeg", - "path": "download/noco/jango_fett/Table1/attachment/uVbjPVQxC_SSfs8Ctx.jpg", - "size": 13052, - "title": "22bc-kavypmq4869759 (1).jpg" - } - }, - "title": "Attachment Request Model", - "properties": { - "mimetype": { - "type": "string", - "description": "The mimetype of the attachment" - }, - "path": { - "type": "string", - "description": "The file path of the attachment" - }, - "size": { - "type": "number", - "description": "The size of the attachment" - }, - "title": { - "type": "string", - "description": "The title of the attachment used in UI" - }, - "url": { - "type": "string", - "description": "Attachment URL to be uploaded via upload-by-url" - } - }, - "x-stoplight": { - "id": "jmahtr8c5rw7f" - } - }, - "Audit": { - "description": "Model for Audit", - "examples": [ - { - "id": "adt_l5we7pkx70vaao", - "user": "w@nocodb.com", - "ip": "::ffff:127.0.0.1", - "base_id": "ds_3l9qx8xqksenrl", - "project_id": "p_9sx43moxhqtjm3", - "fk_model_id": "md_ehn5izr99m7d45", - "row_id": "rec0Adp9PMG9o7uJy", - "op_type": "AUTHENTICATION", - "op_sub_type": "UPDATE", - "status": "string", - "description": "Table nc_snms___Table_1 : field Date got changed from 2023-03-12 to ", - "details": "Date : 2023-03-12 " - } - ], - "title": "Audit Model", - "type": "object", - "properties": { - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "user": { - "type": "string", - "description": "The user name performing the action", - "example": "w@nocodb.com" - }, - "ip": { - "type": "string", - "example": "::ffff:127.0.0.1", - "description": "IP address from the user" - }, - "base_id": { - "type": "string", - "description": "Base ID in where action is performed", - "example": "ds_3l9qx8xqksenrl" - }, - "project_id": { - "type": "string", - "description": "Project ID in where action is performed", - "example": "p_9sx43moxhqtjm3" - }, - "fk_model_id": { - "type": "string", - "description": "Model ID in where action is performed", - "example": "md_ehn5izr99m7d45" - }, - "row_id": { - "type": "string", - "description": "Row ID", - "example": "rec0Adp9PMG9o7uJy" - }, - "op_type": { - "type": "string", - "description": "Operation Type", - "example": "AUTHENTICATION", - "enum": [ - "COMMENT", - "DATA", - "PROJECT", - "VIRTUAL_RELATION", - "RELATION", - "TABLE_VIEW", - "TABLE", - "VIEW", - "META", - "WEBHOOKS", - "AUTHENTICATION", - "TABLE_COLUMN", - "ORG_USER" - ] - }, - "op_sub_type": { - "type": "string", - "description": "Operation Sub Type", - "example": "UPDATE", - "enum": [ - "UPDATE", - "INSERT", - "BULK_INSERT", - "BULK_UPDATE", - "BULK_DELETE", - "LINK_RECORD", - "UNLINK_RECORD", - "DELETE", - "CREATE", - "RENAME", - "IMPORT_FROM_ZIP", - "EXPORT_TO_FS", - "EXPORT_TO_ZIP", - "SIGNIN", - "SIGNUP", - "PASSWORD_RESET", - "PASSWORD_FORGOT", - "PASSWORD_CHANGE", - "EMAIL_VERIFICATION", - "ROLES_MANAGEMENT", - "INVITE", - "RESEND_INVITE" - ] - }, - "status": { - "type": "string", - "description": "Audit Status" - }, - "description": { - "type": "string", - "description": "Description of the action", - "example": "Table nc_snms___Table_1 : field Date got changed from 2023-03-12 to " - }, - "details": { - "type": "string", - "description": "Detail", - "example": "Date : 2023-03-12 " - } - }, - "x-stoplight": { - "id": "i5ug0n7j1wub8" - } - }, - "AuditRowUpdateReq": { - "description": "Model for Audit Row Update Request", - "examples": [ - { - "column_name": "baz", - "fk_model_id": "md_ehn5izr99m7d45", - "row_id": "rec0Adp9PMG9o7uJy", - "prev_value": "foo", - "value": "bar" - } - ], - "title": "Audit Row Update Request Model", - "type": "object", - "properties": { - "column_name": { - "type": "string", - "description": "Column Name", - "example": "baz" - }, - "fk_model_id": { - "type": "string", - "description": "Foreign Key to Model", - "example": "md_ehn5izr99m7d45" - }, - "row_id": { - "type": "string", - "example": "rec0Adp9PMG9o7uJy", - "description": "Row ID" - }, - "prev_value": { - "description": "The previous value before the action" - }, - "value": { - "description": "The current value after the action" - } - }, - "x-stoplight": { - "id": "jcw57b1yv3xog" - } - }, - "Base": { - "description": "Model for Base", - "examples": [ - { - "alias": null, - "config": "", - "enabled": 1, - "id": "ds_krsappzu9f8vmo", - "inflection_column": "camelize", - "inflection_table": "camelize", - "is_meta": 1, - "meta": null, - "order": 1, - "project_id": "p_01clqvzik3izk6", - "type": "mysql2" - } - ], - "title": "Base Model", - "type": "object", - "properties": { - "alias": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Base Name - Default BASE will be null by default" - }, - "config": { - "description": "Base Configuration" - }, - "enabled": { - "$ref": "#/components/schemas/Bool", - "description": "Is this base enabled" - }, - "id": { - "description": "Unique Base ID", - "type": "string" - }, - "inflection_column": { - "description": "Inflection for columns", - "example": "camelize", - "type": "string" - }, - "inflection_table": { - "description": "Inflection for tables", - "example": "camelize", - "type": "string" - }, - "is_meta": { - "$ref": "#/components/schemas/Bool", - "description": "Is the data source connected externally" - }, - "order": { - "description": "The order of the list of bases", - "example": 1, - "type": "number" - }, - "project_id": { - "description": "The project ID that this base belongs to", - "type": "string" - }, - "type": { - "description": "DB Type", - "enum": [ - "mssql", - "mysql", - "mysql2", - "oracledb", - "pg", - "snowflake", - "sqlite3" - ], - "example": "mysql2", - "type": "string" - } - }, - "x-stoplight": { - "id": "9hy3cgp0r2c95" - } - }, - "BaseList": { - "description": "Model for Base List", - "examples": [ - { - "list": [ - { - "alias": null, - "config": "", - "enabled": 1, - "id": "ds_krsappzu9f8vmo", - "inflection_column": "camelize", - "inflection_table": "camelize", - "is_meta": 1, - "meta": null, - "order": 1, - "project_id": "p_01clqvzik3izk6", - "type": "mysql2" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - ], - "title": "Base List Model", - "type": "object", - "x-examples": { - "example-1": { - "bases": { - "list": [ - { - "alias": "sakila", - "config": "", - "created_at": "2023-03-02 11:28:17", - "enabled": 1, - "id": "ds_btbdt19zde0gj9", - "inflection_column": "camelize", - "inflection_table": "camelize", - "is_meta": null, - "meta": null, - "order": 2, - "project_id": "p_01clqvzik3izk6", - "type": "mysql2", - "updated_at": "2023-03-02 11:28:17" - }, - { - "alias": null, - "config": "", - "created_at": "2023-03-01 16:31:49", - "enabled": 1, - "id": "ds_krsappzu9f8vmo", - "inflection_column": "camelize", - "inflection_table": "camelize", - "is_meta": 1, - "meta": null, - "order": 1, - "project_id": "p_01clqvzik3izk6", - "type": "mysql2", - "updated_at": "2023-03-02 11:28:17" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 2, - "totalRows": 2 - } - } - } - }, - "properties": { - "list": { - "type": "array", - "x-stoplight": { - "id": "1q3ny60j1g4z2" - }, - "description": "List of base objects", - "items": { - "$ref": "#/components/schemas/Base", - "x-stoplight": { - "id": "udd0nrcv6pq8d" - } - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated", - "x-stoplight": { - "id": "xqwcniocq37hk" - }, - "description": "Paginated Info" - } - }, - "required": ["list", "pageInfo"], - "x-stoplight": { - "id": "kk8uqxeefumma" - } - }, - "BaseReq": { - "description": "Model for Base Request", - "examples": [ - { - "alias": "My Base", - "config": null, - "inflection_column": "camelize", - "inflection_table": "camelize", - "is_meta": true, - "type": "mysql" - } - ], - "properties": { - "alias": { - "description": "Base Name - Default BASE will be null by default", - "example": "My Base", - "maxLength": 128, - "type": "string" - }, - "config": { - "description": "Base Configuration" - }, - "inflection_column": { - "description": "Inflection for columns", - "example": "camelize", - "type": "string" - }, - "inflection_table": { - "description": "Inflection for tables", - "example": "camelize", - "type": "string" - }, - "is_meta": { - "description": "Is the data source connected externally", - "type": "boolean" - }, - "type": { - "description": "DB Type", - "enum": [ - "mssql", - "mysql", - "mysql2", - "oracledb", - "pg", - "snowflake", - "sqlite3" - ], - "type": "string" - } - }, - "title": "Base Request", - "type": "object", - "x-stoplight": { - "id": "j2z6ain3204zi" - } - }, - "Bool": { - "description": "Model for Bool", - "examples": [true], - "oneOf": [ - { - "description": "0 or 1", - "example": 0, - "type": "integer" - }, - { - "description": "true or false", - "type": "boolean" - }, - { - "type": "null" - } - ], - "title": "Bool Model", - "x-stoplight": { - "id": "8n3vnyr22sbvj" - } - }, - "Column": { - "description": "Model for Column", - "examples": [ - { - "ai": 0, - "au": 0, - "base_id": "ds_krsappzu9f8vmo", - "cc": "", - "cdf": null, - "clen": "45", - "column_name": "title", - "cop": "2", - "created_at": "2023-03-02 13:14:16", - "csn": "utf8mb4", - "ct": "varchar(45)", - "deleted": null, - "dt": "varchar", - "dtx": "specificType", - "dtxp": "45", - "dtxs": null, - "fk_model_id": "md_yvwvbt2i78rgcm", - "id": "cl_0j9gv0oi8vjy46", - "meta": null, - "np": null, - "ns": null, - "order": 2, - "pk": 0, - "project_id": "p_01clqvzik3izk6", - "pv": 1, - "rqd": 0, - "system": 0, - "title": "Title", - "uidt": "SingleLineText", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 13:14:16", - "validate": null, - "virtual": null - } - ], - "title": "Column Model", - "type": "object", - "properties": { - "ai": { - "$ref": "#/components/schemas/Bool", - "description": "Is Auto-Increment?" - }, - "au": { - "$ref": "#/components/schemas/Bool", - "description": "Auto Update Timestamp" - }, - "base_id": { - "description": "Base ID that this column belongs to", - "example": "ds_krsappzu9f8vmo", - "type": "string" - }, - "cc": { - "description": "Column Comment", - "type": "string" - }, - "cdf": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Column Default" - }, - "clen": { - "description": "Character Maximum Length", - "oneOf": [ - { - "type": "integer" - }, - { - "type": "null" - }, - { - "type": "string" - } - ] - }, - "colOptions": { - "anyOf": [ - { - "$ref": "#/components/schemas/Formula" - }, - { - "$ref": "#/components/schemas/LinkToAnotherRecord" - }, - { - "$ref": "#/components/schemas/Lookup" - }, - { - "$ref": "#/components/schemas/Rollup" - }, - { - "$ref": "#/components/schemas/SelectOptions" - }, - { - "type": "object" - } - ], - "description": "Column Options" - }, - "column_name": { - "description": "Column Name", - "example": "title", - "type": "string" - }, - "cop": { - "description": "Column Ordinal Position", - "type": "string" - }, - "csn": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Character Set Name" - }, - "ct": { - "description": "Column Type", - "example": "varchar(45)", - "type": "string" - }, - "deleted": { - "$ref": "#/components/schemas/Bool", - "description": "Is Deleted?" - }, - "dt": { - "description": "Data Type in DB", - "example": "varchar", - "type": "string" - }, - "dtx": { - "description": "Data Type X", - "example": "specificType", - "type": "string" - }, - "dtxp": { - "description": "Data Type X Precision", - "oneOf": [ - { - "type": "null" - }, - { - "type": "number" - }, - { - "type": "string" - } - ] - }, - "dtxs": { - "description": "Data Type X Scale", - "oneOf": [ - { - "type": "null" - }, - { - "type": "number" - }, - { - "type": "string" - } - ] - }, - "fk_model_id": { - "description": "Model ID that this column belongs to", - "example": "md_yvwvbt2i78rgcm", - "type": "string" - }, - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "description": "Meta Info" - }, - "np": { - "description": "Numeric Precision", - "oneOf": [ - { - "type": "integer" - }, - { - "type": "null" - }, - { - "type": "string" - } - ] - }, - "ns": { - "description": "Numeric Scale", - "oneOf": [ - { - "type": "integer" - }, - { - "type": "null" - }, - { - "type": "string" - } - ] - }, - "order": { - "description": "The order of the list of columns", - "type": "number" - }, - "pk": { - "$ref": "#/components/schemas/Bool", - "description": "Is Primary Key?" - }, - "pv": { - "$ref": "#/components/schemas/Bool", - "description": "Is Primary Value?" - }, - "rqd": { - "$ref": "#/components/schemas/Bool", - "description": "Is Required?" - }, - "system": { - "$ref": "#/components/schemas/Bool", - "description": "Is System Column?" - }, - "title": { - "description": "Column Title", - "example": "Title", - "type": "string" - }, - "uidt": { - "description": "The data type in UI", - "example": "SingleLineText", - "enum": [ - "Attachment", - "AutoNumber", - "Barcode", - "Button", - "Checkbox", - "Collaborator", - "Count", - "CreateTime", - "Currency", - "Date", - "DateTime", - "Decimal", - "Duration", - "Email", - "Formula", - "ForeignKey", - "GeoData", - "Geometry", - "ID", - "JSON", - "LastModifiedTime", - "LongText", - "LinkToAnotherRecord", - "Lookup", - "MultiSelect", - "Number", - "Percent", - "PhoneNumber", - "Rating", - "Rollup", - "SingleLineText", - "SingleSelect", - "SpecificDBType", - "Time", - "URL", - "Year", - "QrCode" - ], - "type": "string" - }, - "un": { - "$ref": "#/components/schemas/Bool", - "description": "Is Unsigned?" - }, - "unique": { - "$ref": "#/components/schemas/Bool", - "description": "Is unique?" - }, - "visible": { - "$ref": "#/components/schemas/Bool", - "description": "Is Visible?" - } - }, - "x-stoplight": { - "id": "3a4lsn477mx4e" - } - }, - "ColumnList": { - "description": "Model for Column List", - "examples": [ - { - "list": [ - { - "ai": 0, - "au": 0, - "base_id": "ds_krsappzu9f8vmo", - "cc": "", - "cdf": null, - "clen": "45", - "column_name": "title", - "cop": "2", - "created_at": "2023-03-02 13:14:16", - "csn": "utf8mb4", - "ct": "varchar(45)", - "deleted": null, - "dt": "varchar", - "dtx": "specificType", - "dtxp": "45", - "dtxs": null, - "fk_model_id": "md_yvwvbt2i78rgcm", - "id": "cl_0j9gv0oi8vjy46", - "meta": null, - "np": null, - "ns": null, - "order": 2, - "pk": 0, - "project_id": "p_01clqvzik3izk6", - "pv": 1, - "rqd": 0, - "system": 0, - "title": "Title", - "uidt": "SingleLineText", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 13:14:16", - "validate": null, - "virtual": null - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - ], - "title": "Column List Model", - "type": "object", - "x-examples": { - "example-1": { - "bases": { - "list": [ - { - "alias": "string", - "database": "string", - "host": "string", - "id": "string", - "params": "string", - "password": "string", - "port": 0, - "project_id": "string", - "ssl": "string", - "type": "string", - "url": "string", - "username": "string" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "pageSize": 0, - "sort": "string", - "totalRows": 0 - } - } - } - }, - "properties": { - "list": { - "type": "array", - "x-stoplight": { - "id": "c6lpw8px25356" - }, - "description": "List of column objects", - "items": { - "$ref": "#/components/schemas/Column", - "x-stoplight": { - "id": "zbm89i86dr73y" - } - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated", - "x-stoplight": { - "id": "ko0s0z13h4hsw" - } - } - }, - "required": ["list", "pageInfo"], - "x-stoplight": { - "id": "rldg44w1alasg" - } - }, - "ColumnReq": { - "allOf": [ - { - "anyOf": [ - { - "$ref": "#/components/schemas/FormulaColumnReq" - }, - { - "$ref": "#/components/schemas/LinkToAnotherColumnReq" - }, - { - "$ref": "#/components/schemas/LookupColumnReq" - }, - { - "$ref": "#/components/schemas/NormalColumnRequest" - }, - { - "$ref": "#/components/schemas/RollupColumnReq" - } - ] - }, - { - "properties": { - "column_name": { - "type": "string" - }, - "column_order": { - "description": "Column order in a specific view", - "properties": { - "order": { - "type": "number" - }, - "view_id": { - "type": "string" - } - }, - "type": "object" - }, - "title": { - "maxLength": 255, - "minLength": 1, - "type": "string" - } - }, - "required": ["title"] - } - ], - "description": "Model for Column Request", - "examples": [ - { - "ai": 0, - "au": 0, - "base_id": "ds_krsappzu9f8vmo", - "cc": "", - "cdf": null, - "clen": "45", - "column_name": "title", - "cop": "2", - "created_at": "2023-03-02 13:14:16", - "csn": "utf8mb4", - "ct": "varchar(45)", - "deleted": null, - "dt": "varchar", - "dtx": "specificType", - "dtxp": "45", - "dtxs": null, - "fk_model_id": "md_yvwvbt2i78rgcm", - "id": "cl_0j9gv0oi8vjy46", - "meta": null, - "np": null, - "ns": null, - "order": 2, - "pk": 0, - "project_id": "p_01clqvzik3izk6", - "pv": 1, - "rqd": 0, - "system": 0, - "title": "Title", - "uidt": "SingleLineText", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 13:14:16", - "validate": null, - "virtual": null - } - ], - "title": "Column Request Model", - "type": "object", - "x-stoplight": { - "id": "dvbn9dnme6jgi" - } - }, - "CommentReq": { - "description": "Model for Comment Request", - "examples": [ - { - "description": "This is the comment for the row", - "fk_model_id": "md_ehn5izr99m7d45", - "row_id": "3" - } - ], - "title": "Comment Request Model", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Description for the target row", - "example": "This is the comment for the row" - }, - "fk_model_id": { - "type": "string", - "description": "Foreign Key to Model", - "example": "md_ehn5izr99m7d45" - }, - "row_id": { - "type": "string", - "description": "Row ID", - "example": "3" - } - }, - "required": ["fk_model_id", "row_id"], - "x-stoplight": { - "id": "7nwlyinuliuvy" - } - }, - "CommentUpdateReq": { - "description": "Model for Comment Update Request", - "x-stoplight": { - "id": "r0f3ng2rahe38" - }, - "examples": [ - { - "description": "This is the comment for the row" - } - ], - "title": "Comment Update Request Model", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Description for the target row", - "example": "This is the comment for the row" - } - } - }, - "Filter": { - "description": "Model for Filter", - "examples": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "comparison_op": "eq", - "comparison_sub_op": null, - "created_at": "2023-03-02 18:18:05", - "fk_column_id": "cl_d7ah9n2qfupgys", - "fk_hook_id": null, - "fk_parent_id": null, - "fk_view_id": "vw_b739e29vqmrxnf", - "id": "fi_xn647tpmdq8fu8", - "is_group": null, - "logical_op": "and", - "order": 1, - "project_id": "p_xm3thidrblw4n7", - "updated_at": "2023-03-02 18:18:05", - "value": "foo" - } - ], - "properties": { - "base_id": { - "description": "Unqiue Base ID", - "readOnly": true, - "type": "string" - }, - "children": { - "description": "Children filters. Available when the filter is grouped.", - "items": { - "$ref": "#/components/schemas/Filter" - }, - "type": "array" - }, - "comparison_op": { - "description": "Comparison Operator", - "enum": [ - "allof", - "anyof", - "blank", - "btw", - "checked", - "empty", - "eq", - "ge", - "gt", - "gte", - "in", - "is", - "isWithin", - "isnot", - "le", - "like", - "lt", - "lte", - "nallof", - "nanyof", - "nbtw", - "neq", - "nlike", - "not", - "notblank", - "notchecked", - "notempty", - "notnull", - "null" - ], - "type": "string" - }, - "comparison_sub_op": { - "anyOf": [ - { - "enum": [ - "daysAgo", - "daysFromNow", - "exactDate", - "nextMonth", - "nextNumberOfDays", - "nextWeek", - "nextYear", - "oneMonthAgo", - "oneMonthFromNow", - "oneWeekAgo", - "oneWeekFromNow", - "pastMonth", - "pastNumberOfDays", - "pastWeek", - "pastYear", - "today", - "tomorrow", - "yesterday" - ], - "type": "string" - }, - { - "type": "null" - } - ], - "description": "Comparison Sub-Operator" - }, - "fk_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Column" - }, - "fk_hook_id": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Foreign Key to Hook" - }, - "fk_model_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Model" - }, - "fk_parent_id": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Foreign Key to parent group." - }, - "fk_view_id": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Foreign Key to View" - }, - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "is_group": { - "description": "Is this filter grouped?", - "oneOf": [ - { - "type": "boolean" - }, - { - "type": "integer" - }, - { - "type": "null" - } - ] - }, - "logical_op": { - "description": "Logical Operator", - "enum": ["and", "not", "or"], - "type": "string" - }, - "project_id": { - "description": "Unique Project ID", - "readOnly": true, - "type": "string" - }, - "value": { - "description": "The filter value. Can be NULL for some operators." - } - }, - "readOnly": true, - "title": "Filter Model", - "type": "object", - "x-stoplight": { - "id": "f8vsb8alix01i" - } - }, - "FilterList": { - "description": "Model for Filter List", - "examples": [ - { - "list": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "comparison_op": "eq", - "comparison_sub_op": null, - "created_at": "2023-03-02 18:18:05", - "fk_column_id": "cl_d7ah9n2qfupgys", - "fk_hook_id": null, - "fk_parent_id": null, - "fk_view_id": "vw_b739e29vqmrxnf", - "id": "fi_xn647tpmdq8fu8", - "is_group": null, - "logical_op": "and", - "order": 1, - "project_id": "p_xm3thidrblw4n7", - "updated_at": "2023-03-02 18:18:05", - "value": "foo" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - ], - "title": "Filter List Model", - "type": "object", - "x-examples": { - "example-1": { - "bases": { - "list": [ - { - "alias": "string", - "database": "string", - "host": "string", - "id": "string", - "params": "string", - "password": "string", - "port": 0, - "project_id": "string", - "ssl": "string", - "type": "string", - "url": "string", - "username": "string" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "pageSize": 0, - "sort": "string", - "totalRows": 0 - } - } - } - }, - "properties": { - "list": { - "type": "array", - "x-stoplight": { - "id": "22sgv37ve9kxo" - }, - "description": "List of filter objects", - "items": { - "$ref": "#/components/schemas/Filter", - "x-stoplight": { - "id": "ttw5rxhy83k8p" - } - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated", - "x-stoplight": { - "id": "7cyrb1770mrzz" - } - } - }, - "required": ["list", "pageInfo"], - "x-stoplight": { - "id": "mfxg43iomcoue" - } - }, - "FilterLogList": { - "description": "Model for Filter Log List", - "x-stoplight": { - "id": "0voe9zdizy5qd" - }, - "examples": [ - { - "list": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "comparison_op": "eq", - "comparison_sub_op": null, - "created_at": "2023-03-02 18:18:05", - "fk_column_id": "cl_d7ah9n2qfupgys", - "fk_hook_id": null, - "fk_parent_id": null, - "fk_view_id": "vw_b739e29vqmrxnf", - "id": "fi_xn647tpmdq8fu8", - "is_group": null, - "logical_op": "and", - "order": 1, - "project_id": "p_xm3thidrblw4n7", - "updated_at": "2023-03-02 18:18:05", - "value": "foo" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - ], - "title": "Filter Log List Model", - "type": "object", - "x-examples": { - "example-1": { - "bases": { - "list": [ - { - "alias": "string", - "database": "string", - "host": "string", - "id": "string", - "params": "string", - "password": "string", - "port": 0, - "project_id": "string", - "ssl": "string", - "type": "string", - "url": "string", - "username": "string" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "pageSize": 0, - "sort": "string", - "totalRows": 0 - } - } - } - }, - "properties": { - "list": { - "type": "array", - "x-stoplight": { - "id": "22sgv37ve9kxo" - }, - "description": "List of filter objects", - "items": { - "$ref": "#/components/schemas/Filter", - "x-stoplight": { - "id": "ttw5rxhy83k8p" - } - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated", - "x-stoplight": { - "id": "7cyrb1770mrzz" - } - } - }, - "required": ["list", "pageInfo"] - }, - "FilterReq": { - "description": "Model for Filter Request", - "examples": [ - { - "comparison_op": "eq", - "comparison_sub_op": null, - "fk_column_id": "cl_d7ah9n2qfupgys", - "is_group": false, - "logical_op": "and", - "value": "foo" - } - ], - "title": "Filter Request Model", - "type": "object", - "x-stoplight": { - "id": "pugjn1hobswqf" - }, - "properties": { - "comparison_op": { - "description": "Comparison Operator", - "enum": [ - "allof", - "anyof", - "blank", - "btw", - "checked", - "empty", - "eq", - "ge", - "gt", - "gte", - "in", - "is", - "isWithin", - "isnot", - "le", - "like", - "lt", - "lte", - "nallof", - "nanyof", - "nbtw", - "neq", - "nlike", - "not", - "notblank", - "notchecked", - "notempty", - "notnull", - "null" - ], - "type": "string" - }, - "comparison_sub_op": { - "anyOf": [ - { - "enum": [ - "daysAgo", - "daysFromNow", - "exactDate", - "nextMonth", - "nextNumberOfDays", - "nextWeek", - "nextYear", - "oneMonthAgo", - "oneMonthFromNow", - "oneWeekAgo", - "oneWeekFromNow", - "pastMonth", - "pastNumberOfDays", - "pastWeek", - "pastYear", - "today", - "tomorrow", - "yesterday" - ], - "type": "string" - }, - { - "type": "null" - } - ], - "description": "Comparison Sub-Operator" - }, - "fk_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Column" - }, - "fk_parent_id": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Belong to which filter ID" - }, - "is_group": { - "$ref": "#/components/schemas/Bool", - "description": "Is this filter grouped?" - }, - "logical_op": { - "description": "Logical Operator", - "enum": ["and", "not", "or"], - "type": "string" - }, - "value": { - "description": "The filter value. Can be NULL for some operators." - } - }, - "readOnly": true - }, - "Form": { - "description": "Model for Form", - "examples": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "banner_image_url": null, - "columns": [ - { - "id": "fvc_ugj9zo5bzocxtl", - "base_id": "ds_g4ccx6e77h1dmi", - "project_id": "p_xm3thidrblw4n7", - "fk_view_id": "vw_kdf5cr7qmhksek", - "fk_column_id": "cl_phvuuwjrzcdo0g", - "uuid": null, - "label": null, - "help": null, - "description": null, - "required": null, - "show": 0, - "order": 1, - "created_at": "2023-03-04 16:40:47", - "updated_at": "2023-03-04 16:40:47", - "meta": {} - } - ], - "email": "user@example.com", - "fk_model_id": "md_rsu68aqjsbyqtl", - "heading": "My Form", - "lock_type": "collaborative", - "logo_url": null, - "meta": null, - "redirect_after_secs": null, - "redirect_url": null, - "show_blank_form": 0, - "subheading": "My Form Subheading", - "submit_another_form": 0, - "success_msg": "Thank you for the submission.", - "title": "Form View 1" - } - ], - "title": "Form Model", - "type": "object", - "properties": { - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID", - "x-stoplight": { - "id": "z6wjvs00d3qfk" - } - }, - "banner_image_url": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Banner Image URL. Not in use currently." - }, - "columns": { - "type": "array", - "description": "Form Columns", - "items": { - "$ref": "#/components/schemas/FormColumn" - } - }, - "email": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Email to sned after form is submitted" - }, - "fk_model_id": { - "type": "string", - "description": "Foreign Key to Model", - "example": "md_rsu68aqjsbyqtl" - }, - "base_id": { - "type": "string", - "description": "Base ID", - "example": "md_rsu68aqjsbyqtl", - "x-stoplight": { - "id": "kfz7tve8nzj6f" - } - }, - "heading": { - "type": "string", - "description": "The heading of the form", - "example": "My Form" - }, - "lock_type": { - "enum": ["collaborative", "locked", "personal"], - "type": "string", - "description": "Lock Type of this view", - "example": "collaborative" - }, - "logo_url": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Logo URL. Not in use currently." - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "description": "Meta Info for this view" - }, - "redirect_after_secs": { - "$ref": "#/components/schemas/StringOrNull", - "description": "The numbers of seconds to redirect after form submission" - }, - "redirect_url": { - "$ref": "#/components/schemas/StringOrNull", - "description": "URL to redirect after submission" - }, - "show_blank_form": { - "$ref": "#/components/schemas/Bool", - "description": "Show `Blank Form` after 5 seconds" - }, - "subheading": { - "type": "string", - "description": "The subheading of the form", - "example": "My Form Subheading" - }, - "submit_another_form": { - "$ref": "#/components/schemas/Bool", - "description": "Show `Submit Another Form` button" - }, - "success_msg": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Custom message after the form is successfully submitted" - }, - "title": { - "type": "string", - "description": "Form View Title", - "example": "Form View 1" - } - }, - "x-stoplight": { - "id": "918aga51qb7w1" - } - }, - "FormUpdateReq": { - "description": "Model for Form Update Request", - "examples": [ - { - "banner_image_url": null, - "email": "user@example.com", - "heading": "My Form", - "logo_url": null, - "meta": null, - "redirect_after_secs": null, - "redirect_url": null, - "show_blank_form": 0, - "subheading": "My Form Subheading", - "submit_another_form": 0, - "success_msg": "Thank you for the submission." - } - ], - "title": "Form Update Request Model", - "type": "object", - "properties": { - "banner_image_url": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Banner Image URL. Not in use currently." - }, - "email": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Email to sned after form is submitted" - }, - "heading": { - "description": "The heading of the form", - "example": "My Form", - "maxLength": 255, - "type": "string" - }, - "logo_url": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Logo URL. Not in use currently." - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "description": "Meta Info for this view" - }, - "redirect_after_secs": { - "$ref": "#/components/schemas/StringOrNull", - "description": "The numbers of seconds to redirect after form submission" - }, - "redirect_url": { - "$ref": "#/components/schemas/StringOrNull", - "description": "URL to redirect after submission" - }, - "show_blank_form": { - "$ref": "#/components/schemas/Bool", - "description": "Show `Blank Form` after 5 seconds" - }, - "subheading": { - "$ref": "#/components/schemas/StringOrNull", - "description": "The subheading of the form" - }, - "submit_another_form": { - "$ref": "#/components/schemas/Bool", - "description": "Show `Submit Another Form` button" - }, - "success_msg": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Custom message after the form is successfully submitted" - } - }, - "x-stoplight": { - "id": "zn4juts75pksq" - } - }, - "FormColumn": { - "description": "Model for Form Column", - "examples": [ - { - "id": "fvc_1m9b0aub791d4m", - "description": null, - "fk_column_id": "cl_ah9zavkn25ihyd", - "fk_view_id": "vw_6fqln9vdytdv8q", - "help": "This is a help text", - "label": "Form Label", - "meta": null, - "order": 1, - "required": 0, - "show": 0, - "uuid": null - } - ], - "title": "Form Column Model", - "type": "object", - "x-examples": { - "example-1": { - "_cn": "first_name", - "alias": "first_name", - "created_at": "2022-02-15 12:39:04", - "description": "dsdsdsdsd", - "fk_column_id": "cl_yvyhsl9u81tokc", - "fk_view_id": "vw_s1pf4umdnikoyn", - "help": null, - "id": "fvc_8z1i7t8aswkqxx", - "label": "dsdsds", - "order": 1, - "required": false, - "show": 1, - "enable_scanner": true, - "updated_at": "2022-02-15 12:39:16", - "uuid": null - } - }, - "properties": { - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "description": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Form Column Description (Not in use)" - }, - "fk_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Column" - }, - "fk_view_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to View" - }, - "help": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Form Column Help Text" - }, - "label": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Form Column Label" - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "description": "Meta Info" - }, - "order": { - "type": "number", - "description": "The order among all the columns in the form", - "example": 1 - }, - "required": { - "$ref": "#/components/schemas/Bool", - "description": "Is this form column required in submission?" - }, - "show": { - "$ref": "#/components/schemas/Bool", - "description": "Is this column shown in Form?" - }, - "enable_scanner": { - "$ref": "#/components/schemas/Bool", - "description": "Indicates whether the 'Fill by scan' button is visible for this column or not.", - "example": true - }, - "uuid": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Form Column UUID (Not in use)" - } - }, - "x-stoplight": { - "id": "gm46pinkspvrz" - } - }, - "FormColumnReq": { - "description": "Model for Form Column Request", - "examples": [ - { - "description": null, - "help": "This is a help text", - "label": "Form Label", - "meta": null, - "order": 1, - "required": 0, - "show": 0 - } - ], - "title": "Form Column Request Model", - "type": "object", - "x-examples": { - "example-1": { - "_cn": "first_name", - "alias": "first_name", - "created_at": "2022-02-15 12:39:04", - "description": "dsdsdsdsd", - "fk_column_id": "cl_yvyhsl9u81tokc", - "fk_view_id": "vw_s1pf4umdnikoyn", - "help": null, - "id": "fvc_8z1i7t8aswkqxx", - "label": "dsdsds", - "order": 1, - "required": false, - "show": 1, - "updated_at": "2022-02-15 12:39:16", - "uuid": null - } - }, - "properties": { - "description": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Form Column Description (Not in use)" - }, - "help": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Form Column Help Text" - }, - "label": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Form Column Label" - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "description": "Meta Info" - }, - "order": { - "type": "number", - "description": "The order among all the columns in the form" - }, - "required": { - "$ref": "#/components/schemas/Bool", - "description": "Is this form column required in submission?" - }, - "show": { - "$ref": "#/components/schemas/Bool", - "description": "Is this column shown in Form?" - } - }, - "x-stoplight": { - "id": "nmffmb1p3wkg9" - } - }, - "Formula": { - "description": "Model for Formula", - "examples": [ - { - "id": "fm_1lo8wqtvvipdns", - "fk_column_id": "cl_h2micb4jdnmsh1", - "formula": "CONCAT(\"FOO\", {{cl_c5knoi4xs4sfpt}})", - "formula_raw": "CONCAT(\"FOO\", {Title})", - "error": "Error Message shows here" - } - ], - "title": "Formula Model", - "type": "object", - "properties": { - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "fk_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Column" - }, - "formula": { - "type": "string", - "description": "Formula with column ID replaced", - "example": "CONCAT(\"FOO\", {{cl_c5knoi4xs4sfpt}})" - }, - "formula_raw": { - "type": "string", - "description": "Original Formula inputted in UI", - "example": "CONCAT(\"FOO\", {Title})" - }, - "error": { - "type": "string", - "description": "Error Message" - } - }, - "x-stoplight": { - "id": "hlu7yokpavxwb" - } - }, - "FormulaColumnReq": { - "description": "Model for Formula Column Request", - "examples": [ - { - "formula": "CONCAT(\"FOO\", {{cl_c5knoi4xs4sfpt}})", - "formula_raw": "CONCAT(\"FOO\", {Title})", - "title": "Formula", - "uidt": "Formula" - } - ], - "title": "Formula Column Request Model", - "type": "object", - "properties": { - "formula": { - "type": "string", - "description": "Formula with column ID replaced" - }, - "formula_raw": { - "type": "string", - "description": "Original Formula inputted in UI" - }, - "title": { - "maxLength": 255, - "minLength": 1, - "type": "string", - "description": "Formula Title" - }, - "uidt": { - "enum": ["Formula"], - "type": "string", - "description": "UI Data Type" - } - }, - "x-stoplight": { - "id": "v26r0c9hlimtv" - } - }, - "Gallery": { - "description": "Model for Gallery", - "examples": [ - { - "alias": "string", - "columns": [ - { - "fk_col_id": "string", - "fk_gallery_id": "string", - "help": "string", - "id": "string", - "label": "string" - } - ], - "cover_image": "string", - "cover_image_idx": 0, - "deleted": true, - "fk_cover_image_col_id": "string", - "fk_model_id": "string", - "fk_view_id": "string", - "lock_type": "collaborative", - "next_enabled": true, - "order": 0, - "prev_enabled": true, - "restrict_number": "string", - "restrict_size": "string", - "restrict_types": "string", - "title": "string" - } - ], - "properties": { - "alias": { - "type": "string" - }, - "columns": { - "items": { - "$ref": "#/components/schemas/GalleryColumn" - }, - "type": "array" - }, - "cover_image": { - "type": "string" - }, - "cover_image_idx": { - "type": "integer" - }, - "deleted": { - "$ref": "#/components/schemas/Bool" - }, - "fk_cover_image_col_id": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Foreign Key to Cover Image Column" - }, - "fk_model_id": { - "type": "string", - "description": "Foreign Key to Model" - }, - "fk_view_id": { - "type": "string", - "description": "Foreign Key to View" - }, - "lock_type": { - "enum": ["collaborative", "locked", "personal"], - "type": "string" - }, - "next_enabled": { - "$ref": "#/components/schemas/Bool" - }, - "order": { - "type": "number", - "description": "Order of Gallery" - }, - "prev_enabled": { - "$ref": "#/components/schemas/Bool" - }, - "restrict_number": { - "type": "string" - }, - "restrict_size": { - "type": "string" - }, - "restrict_types": { - "type": "string" - }, - "title": { - "type": "string" - } - }, - "title": "Gallery Model", - "type": "object", - "x-stoplight": { - "id": "i0h7av37o4eks" - } - }, - "GalleryColumn": { - "description": "Model for Gallery Column", - "examples": [ - { - "fk_col_id": "string", - "fk_gallery_id": "string", - "help": "string", - "id": "string", - "label": "string" - } - ], - "properties": { - "fk_col_id": { - "type": "string" - }, - "fk_gallery_id": { - "type": "string" - }, - "help": { - "type": "string" - }, - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "label": { - "type": "string" - } - }, - "title": "Gallery Column Model", - "type": "object", - "x-stoplight": { - "id": "jdhvl7gb33fqo" - } - }, - "GalleryUpdateReq": { - "description": "Model for Gallery View Update Request", - "x-stoplight": { - "id": "x57k1fq4101e1" - }, - "examples": [ - { - "fk_cover_image_col_id": "cl_ib8l4j1kiu1efx", - "meta": null - } - ], - "title": "Gallery View Update Request Model", - "type": "object", - "properties": { - "fk_cover_image_col_id": { - "$ref": "#/components/schemas/StringOrNull", - "description": "The id of the column that contains the cover image" - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "x-stoplight": { - "id": "zhp6jkrr54wuf" - }, - "description": "Meta Info" - } - } - }, - "GeoLocation": { - "description": "Model for Geo Location", - "examples": [ - { - "latitude": 18.52139, - "longitude": 179.87295 - } - ], - "properties": { - "latitude": { - "description": "The latitude of the location", - "example": 18.52139, - "exclusiveMaximum": 90, - "exclusiveMinimum": -90, - "format": "double", - "type": "number" - }, - "longitude": { - "description": "The longitude of the location", - "example": 179.87295, - "exclusiveMaximum": 180, - "exclusiveMinimum": -180, - "format": "double", - "type": "number" - } - }, - "title": "Geo Location Model", - "type": "object", - "x-stoplight": { - "id": "685e1l91iuxhv" - } - }, - "Grid": { - "description": "Model for Grid", - "examples": [ - { - "project_id": "p_xm3thidrblw4n7", - "base_id": "ds_g4ccx6e77h1dmi", - "fk_view_id": "vw_p2jcatxz4mvcfw", - "row_height": 1, - "meta": null, - "columns": [ - { - "id": "cl_phvuuwjrzcdo0g", - "base_id": "ds_g4ccx6e77h1dmi", - "project_id": "p_xm3thidrblw4n7", - "fk_model_id": "md_rsu68aqjsbyqtl", - "title": "Id", - "column_name": "id", - "uidt": "ID", - "dt": "int", - "np": "10", - "ns": "0", - "clen": null, - "cop": "1", - "pk": 1, - "pv": null, - "rqd": 1, - "un": 1, - "ct": "int unsigned", - "ai": 1, - "unique": 0, - "cdf": null, - "cc": "", - "csn": null, - "dtx": "specificType", - "dtxp": "", - "dtxs": "0", - "au": 0, - "validate": null, - "virtual": null, - "deleted": null, - "system": 0, - "order": 1, - "created_at": "2023-03-02 17:04:06", - "updated_at": "2023-03-02 17:04:06", - "meta": null - } - ] - } - ], - "title": "Grid Model", - "type": "object", - "properties": { - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID", - "x-stoplight": { - "id": "e3ti3fc0ocjyu" - } - }, - "project_id": { - "$ref": "#/components/schemas/Id", - "description": "Project ID", - "x-stoplight": { - "id": "e3ti3fc0ocjyu" - } - }, - "base_id": { - "$ref": "#/components/schemas/Id", - "description": "Base ID", - "x-stoplight": { - "id": "m8v3iyf1tidy9" - } - }, - "fk_view_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to View", - "x-stoplight": { - "id": "m8v3iyf1tidy9" - } - }, - "row_height": { - "type": "number", - "example": 1, - "description": "Row Height" - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "x-stoplight": { - "id": "n8cud3jyqw5yv" - }, - "description": "Meta info for Grid Model" - }, - "columns": { - "type": "array", - "x-stoplight": { - "id": "22y0gipx2jdf8" - }, - "description": "Grid View Columns", - "items": { - "$ref": "#/components/schemas/GridColumn", - "x-stoplight": { - "id": "nmzp6w3o6b24u" - } - } - } - }, - "x-stoplight": { - "id": "1xswddf91q5pu" - } - }, - "Grid - copy": { - "description": "Model for Grid", - "x-stoplight": { - "id": "xheueli0578g0" - }, - "examples": [ - { - "project_id": "p_xm3thidrblw4n7", - "base_id": "ds_g4ccx6e77h1dmi", - "fk_view_id": "vw_p2jcatxz4mvcfw", - "row_height": 1, - "meta": null, - "columns": [ - { - "id": "cl_phvuuwjrzcdo0g", - "base_id": "ds_g4ccx6e77h1dmi", - "project_id": "p_xm3thidrblw4n7", - "fk_model_id": "md_rsu68aqjsbyqtl", - "title": "Id", - "column_name": "id", - "uidt": "ID", - "dt": "int", - "np": "10", - "ns": "0", - "clen": null, - "cop": "1", - "pk": 1, - "pv": null, - "rqd": 1, - "un": 1, - "ct": "int unsigned", - "ai": 1, - "unique": 0, - "cdf": null, - "cc": "", - "csn": null, - "dtx": "specificType", - "dtxp": "", - "dtxs": "0", - "au": 0, - "validate": null, - "virtual": null, - "deleted": null, - "system": 0, - "order": 1, - "created_at": "2023-03-02 17:04:06", - "updated_at": "2023-03-02 17:04:06", - "meta": null - } - ] - } - ], - "title": "Grid Model", - "type": "object", - "properties": { - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID", - "x-stoplight": { - "id": "e3ti3fc0ocjyu" - } - }, - "project_id": { - "$ref": "#/components/schemas/Id", - "description": "Project ID", - "x-stoplight": { - "id": "e3ti3fc0ocjyu" - } - }, - "base_id": { - "$ref": "#/components/schemas/Id", - "description": "Base ID", - "x-stoplight": { - "id": "m8v3iyf1tidy9" - } - }, - "fk_view_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to View", - "x-stoplight": { - "id": "m8v3iyf1tidy9" - } - }, - "row_height": { - "type": "number", - "example": 1, - "description": "Row Height" - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "x-stoplight": { - "id": "n8cud3jyqw5yv" - }, - "description": "Meta info for Grid Model" - }, - "columns": { - "type": "array", - "x-stoplight": { - "id": "22y0gipx2jdf8" - }, - "description": "Grid View Columns", - "items": { - "$ref": "#/components/schemas/GridColumn", - "x-stoplight": { - "id": "nmzp6w3o6b24u" - } - } - } - } - }, - "GridColumn": { - "description": "Model for Grid Column", - "examples": [ - { - "id": "nc_c8jz4kxe6xvh11", - "fk_view_id": "vw_p2jcatxz4mvcfw", - "fk_column_id": "cl_c5knoi4xs4sfpt", - "project_id": "p_xm3thidrblw4n7", - "base_id": "ds_g4ccx6e77h1dmi", - "show": 0, - "order": 1, - "width": "200px", - "help": null - } - ], - "title": "Grid Column Model", - "type": "object", - "properties": { - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID", - "x-stoplight": { - "id": "jc14yojp52rqj" - } - }, - "fk_view_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to View", - "x-stoplight": { - "id": "vl18dbt5c2r8r" - } - }, - "fk_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Column", - "x-stoplight": { - "id": "2drg88fmodf3v" - } - }, - "project_id": { - "$ref": "#/components/schemas/Id", - "description": "Project ID", - "x-stoplight": { - "id": "2drg88fmodf3v" - } - }, - "base_id": { - "$ref": "#/components/schemas/Id", - "description": "Base ID", - "x-stoplight": { - "id": "2drg88fmodf3v" - } - }, - "show": { - "$ref": "#/components/schemas/Bool", - "x-stoplight": { - "id": "d47eer13oa8yr" - } - }, - "order": { - "type": "number", - "x-stoplight": { - "id": "d47eer13oa8yr" - }, - "example": 1, - "description": "Grid Column Order" - }, - "width": { - "type": "string", - "description": "Column Width", - "example": "200px" - }, - "help": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Column Help Text", - "x-stoplight": { - "id": "azwh6zn37qzkc" - } - } - }, - "x-stoplight": { - "id": "g06nri6t6h6ke" - } - }, - "GridColumnReq": { - "description": "Model for Grid Column Request", - "examples": [ - { - "fk_column_id": "cl_c5knoi4xs4sfpt", - "label": "My Column", - "width": "200px" - } - ], - "properties": { - "fk_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Column" - }, - "help": { - "maxLength": 255, - "type": "string" - }, - "label": { - "description": "The label of the column", - "example": "My Column", - "maxLength": 255, - "type": "string" - }, - "width": { - "description": "The width of the column", - "example": "200px", - "maxLength": 255, - "pattern": "^[0-9]+(px|%)$", - "type": "string" - } - }, - "title": "Grid Column Request Model", - "type": "object", - "x-stoplight": { - "id": "8v9cxve0332zg" - } - }, - "GridUpdateReq": { - "description": "Model for Grid View Update", - "x-stoplight": { - "id": "g10t5gray4bk5" - }, - "examples": [ - { - "row_height": "1", - "meta": null - } - ], - "title": "Grid View Update Model", - "type": "object", - "properties": { - "row_height": { - "type": "number", - "x-stoplight": { - "id": "m5976ax1q13cr" - }, - "description": "Row Height", - "example": 1 - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "x-stoplight": { - "id": "dugbkhe9iupqu" - }, - "description": "Meta Info for grid view" - } - } - }, - "Hook": { - "description": "Model for Hook", - "examples": [ - { - "active": 0, - "async": 0, - "description": "This is my hook description", - "env": "all", - "event": "after", - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "string", - "notification": "{\"type\":\"URL\",\"payload\":{\"method\":\"POST\",\"body\":\"{{ json data }}\",\"headers\":[{}],\"parameters\":[{}],\"auth\":\"\",\"path\":\"http://example.com\"}}", - "null": null, - "operation": "insert", - "retries": 10, - "retry_interval": 60000, - "timeout": 60000, - "title": "My Webhook" - } - ], - "title": "Hook Model", - "type": "object", - "x-stoplight": { - "id": "32blg2oqo6g7p" - }, - "properties": { - "active": { - "$ref": "#/components/schemas/Bool", - "description": "Is the hook active?" - }, - "async": { - "$ref": "#/components/schemas/Bool", - "description": "Is the hook aysnc?" - }, - "description": { - "type": "string", - "description": "Hook Description", - "example": "This is my hook description" - }, - "env": { - "type": "string", - "example": "all", - "description": "Environment for the hook" - }, - "event": { - "enum": ["after", "before"], - "type": "string", - "description": "Event Type for the operation", - "example": "after" - }, - "fk_model_id": { - "type": "string", - "description": "Foreign Key to Model", - "example": "md_rsu68aqjsbyqtl" - }, - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "notification": { - "description": "Hook Notification including info such as type, payload, method, body, and etc", - "type": ["object", "string"] - }, - "operation": { - "enum": [ - "insert", - "update", - "delete", - "bulkInsert", - "bulkUpdate", - "bulkDelete" - ], - "type": "string", - "description": "Hook Operation", - "example": "insert" - }, - "retries": { - "type": "number", - "description": "Retry Count", - "example": 10 - }, - "retry_interval": { - "type": "number", - "description": "Retry Interval", - "example": 60000 - }, - "timeout": { - "type": "number", - "example": 60000, - "description": "Timeout" - }, - "title": { - "type": "string", - "description": "Hook Title", - "example": "My Webhook" - }, - "type": { - "type": "string", - "description": "Hook Type" - }, - "version": { - "type": "string", - "x-stoplight": { - "id": "socewqvadj91n" - }, - "example": "v2", - "description": "Hook Version", - "enum": ["v1", "v2"] - } - } - }, - "HookReq": { - "description": "Model for Hook", - "x-stoplight": { - "id": "85vr8fx3oea31" - }, - "examples": [ - { - "active": 0, - "async": 0, - "description": "This is my hook description", - "env": "all", - "event": "after", - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "string", - "notification": "{\"type\":\"URL\",\"payload\":{\"method\":\"POST\",\"body\":\"{{ json data }}\",\"headers\":[{}],\"parameters\":[{}],\"auth\":\"\",\"path\":\"http://example.com\"}}", - "null": null, - "operation": "insert", - "retries": 10, - "retry_interval": 60000, - "timeout": 60000, - "title": "My Webhook", - "condition": false - } - ], - "title": "Hook Request Model", - "type": "object", - "properties": { - "active": { - "$ref": "#/components/schemas/Bool", - "description": "Is the hook active?" - }, - "async": { - "$ref": "#/components/schemas/Bool", - "description": "Is the hook aysnc?" - }, - "description": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Hook Description" - }, - "env": { - "type": "string", - "example": "all", - "description": "Environment for the hook" - }, - "event": { - "enum": ["after", "before"], - "type": "string", - "description": "Event Type for the operation", - "example": "after" - }, - "fk_model_id": { - "type": "string", - "description": "Foreign Key to Model", - "example": "md_rsu68aqjsbyqtl" - }, - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "notification": { - "description": "Hook Notification including info such as type, payload, method, body, and etc", - "type": ["object", "string"] - }, - "operation": { - "enum": [ - "insert", - "update", - "delete", - "bulkInsert", - "bulkUpdate", - "bulkDelete" - ], - "type": "string", - "description": "Hook Operation", - "example": "insert" - }, - "retries": { - "type": "number", - "description": "Retry Count", - "example": 10 - }, - "retry_interval": { - "type": "number", - "description": "Retry Interval", - "example": 60000 - }, - "timeout": { - "type": "number", - "example": 60000, - "description": "Timeout" - }, - "title": { - "type": "string", - "description": "Hook Title", - "example": "My Webhook" - }, - "type": { - "type": ["string", "null"], - "description": "Hook Type" - }, - "condition": { - "$ref": "#/components/schemas/Bool", - "x-stoplight": { - "id": "wwzoum7rrlwun" - }, - "description": "Is this hook assoicated with some filters" - } - }, - "required": ["event", "notification", "operation", "title"] - }, - "HookList": { - "description": "Model for Hook List", - "examples": [ - { - "list": [ - { - "active": 0, - "async": 0, - "description": "This is my hook description", - "env": "all", - "event": "after", - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "string", - "notification": "{\"type\":\"URL\",\"payload\":{\"method\":\"POST\",\"body\":\"{{ json data }}\",\"headers\":[{}],\"parameters\":[{}],\"auth\":\"\",\"path\":\"http://example.com\"}}", - "null": null, - "operation": "insert", - "retries": 10, - "retry_interval": 60000, - "timeout": 60000, - "title": "My Webhook" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - ], - "title": "Hook List Model", - "type": "object", - "x-examples": { - "example-1": { - "bases": { - "list": [ - { - "alias": "string", - "database": "string", - "host": "string", - "id": "string", - "params": "string", - "password": "string", - "port": 0, - "project_id": "string", - "ssl": "string", - "type": "string", - "url": "string", - "username": "string" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "pageSize": 0, - "sort": "string", - "totalRows": 0 - } - } - } - }, - "properties": { - "list": { - "minItems": 1, - "type": "array", - "uniqueItems": true, - "description": "List of hook objects", - "items": { - "$ref": "#/components/schemas/Hook" - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated" - } - }, - "required": ["list", "pageInfo"], - "x-stoplight": { - "id": "n2sbatqu55day" - } - }, - "HookLog": { - "description": "Model for Hook Log", - "examples": [ - { - "base_id": "ds_jxuewivwbxeum2", - "event": "after", - "execution_time": "98", - "fk_hook_id": "hk_035ijv5qdi97y5", - "id": "string", - "notifications": "{\"type\":\"URL\",\"payload\":{\"method\":\"POST\",\"body\":\"{{ json data }}\",\"headers\":[{}],\"parameters\":[{}],\"auth\":\"\",\"path\":\"https://webhook.site/6eb45ce5-b611-4be1-8b96-c2965755662b\"}}", - "operation": "insert", - "payload": "{\"method\":\"POST\",\"body\":\"{{ json data }}\",\"headers\":[{}],\"parameters\":[{}],\"auth\":\"\",\"path\":\"https://webhook.site/6eb45ce5-b611-4be1-8b96-c2965755662b\"}", - "project_id": "p_tbhl1hnycvhe5l", - "response": "{\"status\":200,\"statusText\":\"OK\",\"headers\":{\"server\":\"nginx\",\"content-type\":\"text/plain; charset=UTF-8\",\"transfer-encoding\":\"chunked\",\"connection\":\"close\",\"vary\":\"Accept-Encoding\",\"x-request-id\":\"53844a7d-ede8-4798-adf7-8af441908a72\",\"x-token-id\":\"6eb45ce5-b611-4be1-8b96-c2965755662b\",\"cache-control\":\"no-cache, private\",\"date\":\"Fri, 24 Mar 2023 10:50:10 GMT\"},\"config\":{\"url\":\"https://webhook.site/6eb45ce5-b611-4be1-8b96-c2965755662b\",\"method\":\"post\",\"data\":\"{\\\"type\\\":\\\"records.after.insert\\\",\\\"id\\\":\\\"a77d97dc-a3e4-4719-9b46-45f93e0cc99a\\\",\\\"data\\\":{\\\"table_id\\\":\\\"md_d8v403o74mf5lf\\\",\\\"table_name\\\":\\\"Sheet-2\\\"}}\",\"headers\":{\"Accept\":\"application/json, text/plain, */*\",\"Content-Type\":\"application/x-www-form-urlencoded\",\"User-Agent\":\"axios/0.21.4\",\"Content-Length\":138},\"params\":{}}}", - "test_call": 0, - "triggered_by": "w@nocodb.com", - "type": "URL" - } - ], - "title": "Hook Log Model", - "type": "object", - "x-stoplight": { - "id": "ni303795b18y5" - }, - "properties": { - "base_id": { - "type": "string", - "description": "Unique Base ID", - "example": "ds_jxuewivwbxeum2" - }, - "conditions": { - "type": "string", - "description": "Hook Conditions" - }, - "error": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Error" - }, - "error_code": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Error Code" - }, - "error_message": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Error Message" - }, - "event": { - "type": "string", - "description": "Hook Event", - "example": "after", - "enum": ["after", "before"] - }, - "execution_time": { - "type": "string", - "description": "Execution Time in milliseconds", - "example": "98" - }, - "fk_hook_id": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Foreign Key to Hook" - }, - "id": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Unique ID" - }, - "notifications": { - "type": "string", - "description": "Hook Notification" - }, - "operation": { - "type": "string", - "description": "Hook Operation", - "enum": [ - "insert", - "update", - "delete", - "bulkInsert", - "bulkUpdate", - "bulkDelete" - ], - "example": "insert" - }, - "payload": { - "type": "string", - "description": "Hook Payload", - "example": "{\"method\":\"POST\",\"body\":\"{{ json data }}\",\"headers\":[{}],\"parameters\":[{}],\"auth\":\"\",\"path\":\"https://webhook.site/6eb45ce5-b611-4be1-8b96-c2965755662b\"}" - }, - "project_id": { - "type": "string", - "description": "Project ID", - "example": "p_tbhl1hnycvhe5l" - }, - "response": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Hook Response" - }, - "test_call": { - "$ref": "#/components/schemas/Bool", - "description": "Is this testing hook call?" - }, - "triggered_by": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Who triggered the hook?" - }, - "type": { - "type": "string", - "example": "URL", - "description": "Hook Type" - } - } - }, - "HookLogList": { - "description": "Model for Hook Log List", - "x-stoplight": { - "id": "tfv7y629w2ap2" - }, - "examples": [], - "title": "Hook Log List Model", - "type": "object", - "x-examples": { - "example-1": { - "bases": { - "list": [ - { - "alias": "string", - "database": "string", - "host": "string", - "id": "string", - "params": "string", - "password": "string", - "port": 0, - "project_id": "string", - "ssl": "string", - "type": "string", - "url": "string", - "username": "string" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "pageSize": 0, - "sort": "string", - "totalRows": 0 - } - } - } - }, - "properties": { - "list": { - "minItems": 1, - "type": "array", - "uniqueItems": true, - "description": "List of hook objects", - "items": { - "$ref": "#/components/schemas/HookLog" - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated" - } - }, - "required": ["list", "pageInfo"] - }, - "HookTestReq": { - "description": "Model for Hook Test Request", - "examples": [ - { - "hook": { - "active": 0, - "async": 0, - "description": "This is my hook description", - "env": "all", - "event": "after", - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "string", - "notification": "{\"type\":\"URL\",\"payload\":{\"method\":\"POST\",\"body\":\"{{ json data }}\",\"headers\":[{}],\"parameters\":[{}],\"auth\":\"\",\"path\":\"http://example.com\"}}", - "null": null, - "operation": "insert", - "retries": 10, - "retry_interval": 60000, - "timeout": 60000, - "title": "My Webhook" - }, - "payload": { - "data": { - "Id": 1, - "Title": "Sample Text", - "CreatedAt": "2023-03-03T10:03:06.484Z", - "UpdatedAt": "2023-03-03T10:03:06.484Z", - "attachment": [ - { - "url": "https://nocodb.com/dummy.png", - "title": "image.png", - "mimetype": "image/png", - "size": 0 - } - ], - "f": "Sample Output" - } - } - } - ], - "title": "Hook Test Request Model", - "type": "object", - "properties": { - "hook": { - "$ref": "#/components/schemas/HookReq" - }, - "payload": { - "description": "Payload to be sent" - } - }, - "required": ["hook", "payload"], - "x-stoplight": { - "id": "w64q11jiv01np" - } - }, - "Id": { - "description": "Model for ID", - "examples": ["string"], - "maxLength": 20, - "minLength": 0, - "title": "ID Model", - "type": "string", - "x-stoplight": { - "id": "obj8r7jhyfoqg" - } - }, - "Kanban": { - "description": "Model for Kanban", - "examples": [ - { - "id": "vw_wqs4zheuo5lgdy", - "fk_grp_col_id": "cl_3704cxcbqt7sj7", - "fk_view_id": "vw_wqs4zheuo5lgdy", - "fk_cover_image_col_id": null, - "columns": [ - { - "id": "kvc_2skkg5mi1eb37f", - "fk_column_id": "cl_hzos4ghyncqi4k", - "fk_view_id": "vw_wqs4zheuo5lgdy", - "base_id": "ds_hd4ojj0xpquaam", - "project_id": "p_kzfl5lb0t3tcok", - "title": "string", - "show": 0, - "order": "1" - } - ], - "meta": null, - "title": "My Kanban" - } - ], - "title": "Kanban Model", - "type": "object", - "properties": { - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "fk_grp_col_id": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Grouping Field Column ID" - }, - "fk_view_id": { - "$ref": "#/components/schemas/Id", - "x-stoplight": { - "id": "1kgw1w06b97nl" - }, - "description": "View ID" - }, - "fk_cover_image_col_id": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Cover Image Column ID" - }, - "columns": { - "type": "array", - "description": "Kanban Columns", - "items": { - "$ref": "#/components/schemas/KanbanColumn" - } - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "description": "Meta Info for Kanban" - }, - "title": { - "type": "string", - "description": "Kanban Title", - "example": "My Kanban" - } - }, - "x-stoplight": { - "id": "sfbbvgbcv7je6" - } - }, - "KanbanColumn": { - "description": "Model for Kanban Column", - "examples": [ - { - "id": "kvc_2skkg5mi1eb37f", - "fk_column_id": "cl_hzos4ghyncqi4k", - "fk_view_id": "vw_wqs4zheuo5lgdy", - "base_id": "ds_hd4ojj0xpquaam", - "project_id": "p_kzfl5lb0t3tcok", - "title": "string", - "show": 0, - "order": "1" - } - ], - "title": "Kanban Column Model", - "type": "object", - "properties": { - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "fk_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Column" - }, - "fk_view_id": { - "$ref": "#/components/schemas/Id", - "x-stoplight": { - "id": "t1fy4zy561ih8" - }, - "description": "Foreign Key to View" - }, - "base_id": { - "$ref": "#/components/schemas/Id", - "x-stoplight": { - "id": "uqq8xmyz97t1u" - }, - "description": "Baes ID\n" - }, - "project_id": { - "$ref": "#/components/schemas/Id", - "x-stoplight": { - "id": "uqq8xmyz97t1u" - }, - "description": "Project ID" - }, - "title": { - "x-stoplight": { - "id": "uqq8xmyz97t1u" - }, - "description": "Project ID", - "type": "string" - }, - "show": { - "$ref": "#/components/schemas/Bool", - "x-stoplight": { - "id": "uqq8xmyz97t1u" - }, - "description": "Is this column shown?" - }, - "order": { - "type": "number", - "x-stoplight": { - "id": "pbnchzgci5dwa" - }, - "example": 1, - "description": "Column Order" - } - }, - "x-stoplight": { - "id": "epfedw9ccxgxe" - } - }, - "KanbanUpdateReq": { - "description": "Model for Kanban Update Request", - "examples": [ - { - "fk_grp_col_id": "cl_g0a89q9xdry3lu", - "fk_cover_image_col_id": "cl_ib8l4j1kiu1efx", - "meta": { - "cl_g0a89q9xdry3lu": [ - { - "id": "uncategorized", - "title": null, - "order": 0, - "color": "#c2f5e8", - "collapsed": false - }, - { - "id": "sl_ihyva6jx6dg0fc", - "fk_column_id": "cl_g0a89q9xdry3lu", - "title": "a", - "color": "#cfdffe", - "order": 1, - "collapsed": false - }, - { - "id": "sl_gqdm5v6t8aetoa", - "fk_column_id": "cl_g0a89q9xdry3lu", - "title": "b", - "color": "#d0f1fd", - "order": 2, - "collapsed": false - }, - { - "id": "sl_eipnl0kn7a9d3c", - "fk_column_id": "cl_g0a89q9xdry3lu", - "title": "cc", - "color": "#c2f5e8", - "order": 3, - "collapsed": false - }, - { - "id": "sl_dei8p2jq0cnlv0", - "fk_column_id": "cl_g0a89q9xdry3lu", - "title": "d", - "color": "#ffdaf6", - "order": 4, - "collapsed": false - } - ] - } - } - ], - "title": "Kanban Update Request Model", - "type": "object", - "properties": { - "fk_grp_col_id": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Foreign Key to Grouping Field Column" - }, - "fk_cover_image_col_id": { - "$ref": "#/components/schemas/StringOrNull", - "x-stoplight": { - "id": "81wn4hzj76wod" - }, - "description": "Foreign Key to Cover Image Column" - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "x-stoplight": { - "id": "stsvdmkli1b0r" - }, - "description": "Meta Info" - } - }, - "x-stoplight": { - "id": "b1jlyk12kfuwx" - } - }, - "LicenseReq": { - "description": "Model for Kanban Request", - "examples": [ - { - "key": "1234567890" - } - ], - "properties": { - "key": { - "description": "The license key", - "example": "1234567890", - "maxLength": 255, - "minLength": 10, - "type": "string" - } - }, - "title": "License Key Request Model", - "type": "object", - "x-stoplight": { - "id": "trgk6qlmgdyfo" - } - }, - "LinkToAnotherColumnReq": { - "description": "Model for LinkToAnotherColumn Request", - "examples": [ - { - "childId": "string", - "parentId": "string", - "title": "string", - "type": "hm", - "uidt": "LinkToAnotherRecord", - "virtual": true - } - ], - "properties": { - "childId": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to chhild column" - }, - "parentId": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to parent column" - }, - "title": { - "maxLength": 255, - "minLength": 1, - "type": "string", - "description": "The title of the virtual column" - }, - "type": { - "enum": ["bt", "hm", "mm"], - "type": "string", - "description": "The type of the relationship" - }, - "uidt": { - "enum": ["LinkToAnotherRecord"], - "type": "string", - "description": "Abstract type of the relationship" - }, - "virtual": { - "$ref": "#/components/schemas/Bool", - "description": "Is this relationship virtual?" - } - }, - "required": ["childId", "parentId", "title", "type", "uidt"], - "title": "LinkToAnotherColumn Request Model", - "type": "object", - "x-stoplight": { - "id": "x59gz5reg12x3" - } - }, - "LinkToAnotherRecord": { - "description": "Model for LinkToAnotherRecord", - "examples": [ - { - "deleted": "string", - "dr": "string", - "fk_child_column_id": "string", - "fk_column_id": "string", - "fk_index_name": "string", - "fk_mm_child_column_id": "string", - "fk_mm_model_id": "string", - "fk_mm_parent_column_id": "string", - "fk_parent_column_id": "string", - "fk_related_model_id": "string", - "id": "string", - "order": "string", - "type": "string", - "ur": "string", - "virtual": true - } - ], - "properties": { - "deleted": { - "type": "string" - }, - "dr": { - "type": "string" - }, - "fk_child_column_id": { - "type": "string" - }, - "fk_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Column" - }, - "fk_index_name": { - "type": "string" - }, - "fk_mm_child_column_id": { - "type": "string" - }, - "fk_mm_model_id": { - "type": "string" - }, - "fk_mm_parent_column_id": { - "type": "string" - }, - "fk_parent_column_id": { - "type": "string" - }, - "fk_related_model_id": { - "type": "string" - }, - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "order": { - "type": "string" - }, - "type": { - "type": "string" - }, - "ur": { - "type": "string" - }, - "virtual": { - "$ref": "#/components/schemas/Bool" - } - }, - "title": "LinkToAnotherRecord Model", - "type": "object", - "x-stoplight": { - "id": "27q0vnr79hxla" - } - }, - "Lookup": { - "description": "Model for Lookup", - "examples": [ - { - "id": "lk_mngsu0e45njbxr", - "fk_column_id": "cl_vdiy9bz7h11kdm", - "fk_relation_column_id": "cl_5jestblzneb649", - "fk_lookup_column_id": "cl_4cm47dtjphgqkv", - "order": 1 - } - ], - "title": "Lookup Model", - "type": "object", - "properties": { - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "fk_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Column" - }, - "fk_lookup_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Lookup Column" - }, - "fk_relation_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Relation Column" - }, - "order": { - "type": "number", - "description": "The order among the list", - "example": 1 - } - }, - "x-stoplight": { - "id": "guyozhka8sx1t" - } - }, - "LookupColumnReq": { - "description": "Model for Lookup Column Request", - "examples": [ - { - "fk_relation_column_id": "cl_5jestblzneb649", - "fk_lookup_column_id": "cl_4cm47dtjphgqkv", - "title": "My Lookup", - "uidt": "Lookup" - } - ], - "title": "Lookup Column Request Model", - "type": "object", - "properties": { - "fk_lookup_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Lookup Column" - }, - "fk_relation_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Relation Column" - }, - "title": { - "maxLength": 255, - "type": "string", - "description": "Lookup Title", - "example": "My Lookup" - }, - "uidt": { - "enum": ["Lookup"], - "type": "string", - "description": "UI DataType" - } - }, - "x-stoplight": { - "id": "hmeckhq2ciwpf" - } - }, - "Map": { - "description": "Model for Map", - "examples": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "columns": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "fk_column_id": "cl_8iw2o4ejzvdyna", - "fk_view_id": "vw_qjt7klod1p9kyv", - "id": "nc_46xcacqn4rc9xf", - "order": 1, - "project_id": "p_xm3thidrblw4n7", - "show": 1 - } - ], - "fk_geo_data_col_id": "cl_8iw2o4ejzvdyna", - "fk_view_id": "vw_qjt7klod1p9kyv", - "meta": {}, - "order": 0, - "project_id": "p_xm3thidrblw4n7", - "show": true, - "title": "My Map" - } - ], - "properties": { - "base_id": { - "description": "The ID of the base that this view belongs to", - "example": "ds_g4ccx6e77h1dmi", - "type": "string" - }, - "columns": { - "description": "Columns in this view", - "items": { - "$ref": "#/components/schemas/MapColumn" - }, - "type": "array" - }, - "fk_geo_data_col_id": { - "description": "Foreign Key to GeoData Column", - "example": "cl_8iw2o4ejzvdyna", - "type": "string" - }, - "fk_view_id": { - "description": "Unique ID for Map", - "example": "vw_qjt7klod1p9kyv", - "type": "string" - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "description": "Meta data for this view" - }, - "order": { - "description": "The order of the map list", - "type": "number" - }, - "project_id": { - "description": "The ID of the project that this view belongs to", - "example": "p_xm3thidrblw4n7", - "type": "string" - }, - "show": { - "description": "To show this Map or not", - "type": "boolean" - }, - "title": { - "description": "Title of Map View", - "example": "My Map", - "type": "string" - } - }, - "title": "Map Model", - "type": "object", - "x-stoplight": { - "id": "hd60sf3k0bs3w" - } - }, - "MapUpdateReq": { - "description": "Model for Map", - "x-stoplight": { - "id": "3hceyh9ukp5ln" - }, - "examples": [ - { - "fk_geo_data_col_id": "cl_8iw2o4ejzvdyna", - "meta": null - } - ], - "title": "Map View Update Request Model", - "type": "object", - "properties": { - "fk_geo_data_col_id": { - "description": "Foreign Key to GeoData Column", - "example": "cl_8iw2o4ejzvdyna", - "type": "string" - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "description": "Meta data for this view" - } - } - }, - "MapColumn": { - "description": "Model for Map Column", - "examples": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "fk_column_id": "cl_8iw2o4ejzvdyna", - "fk_view_id": "vw_qjt7klod1p9kyv", - "id": "nc_46xcacqn4rc9xf", - "order": 1, - "project_id": "p_xm3thidrblw4n7", - "show": 1 - } - ], - "properties": { - "base_id": { - "description": "The ID of the base that this map column belongs to", - "example": "ds_g4ccx6e77h1dmi", - "type": "string" - }, - "fk_column_id": { - "description": "Foreign Key to Column", - "example": "cl_8iw2o4ejzvdyna", - "type": "string" - }, - "fk_view_id": { - "description": "Foreign Key to View", - "example": "vw_qjt7klod1p9kyv", - "type": "string" - }, - "id": { - "description": "Unique ID of Map Column", - "example": "nc_46xcacqn4rc9xf", - "type": "string" - }, - "order": { - "description": "the order in the list of map columns", - "example": 1, - "type": "number" - }, - "project_id": { - "description": "The ID of the project that this map column belongs to", - "example": "p_xm3thidrblw4n7", - "type": "string" - }, - "show": { - "description": "Whether to show this column or not", - "example": 1, - "type": "number" - } - }, - "title": "Map Column Model", - "type": "object", - "x-stoplight": { - "id": "bvk0acuepoqw1" - } - }, - "Meta": { - "description": "Model for Meta", - "examples": [{}], - "oneOf": [ - { - "type": "null" - }, - { - "type": "object" - }, - { - "type": "string" - } - ], - "title": "Meta Model", - "x-stoplight": { - "id": "2ohjoms6hjcym" - } - }, - "ModelRoleVisibility": { - "description": "Model for ModelRoleVisibility", - "examples": [ - { - "base_id": "string", - "disabled": true, - "fk_model_id": "string", - "fk_view_id": "string", - "id": "string", - "project_id": "string", - "role": "string" - } - ], - "properties": { - "base_id": { - "type": "string" - }, - "disabled": { - "$ref": "#/components/schemas/Bool" - }, - "fk_model_id": { - "type": "string" - }, - "fk_view_id": { - "type": "string" - }, - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "project_id": { - "type": "string" - }, - "role": { - "type": "string" - } - }, - "title": "ModelRoleVisibility Model", - "type": "object", - "x-stoplight": { - "id": "68m1dblcswem2" - } - }, - "NormalColumnRequest": { - "description": "Model for Normal Column Request", - "examples": [ - { - "ai": true, - "au": true, - "cc": "string", - "cdf": "string", - "column_name": "string", - "csn": "string", - "dt": "string", - "dtx": "string", - "dtxp": 0, - "dtxs": 0, - "np": 0, - "ns": 0, - "pk": true, - "pv": true, - "rqd": true, - "title": "string", - "uidt": "ID", - "un": true, - "unique": true - } - ], - "properties": { - "ai": { - "$ref": "#/components/schemas/Bool", - "description": "Is this column auto-incremented?" - }, - "au": { - "$ref": "#/components/schemas/Bool", - "description": "Is this column auto-updated datetime field?" - }, - "cc": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Column Comment" - }, - "cdf": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Column Default Value" - }, - "column_name": { - "maxLength": 255, - "minLength": 1, - "type": "string", - "description": "Column Name" - }, - "csn": { - "$ref": "#/components/schemas/StringOrNull" - }, - "dt": { - "type": "string", - "description": "Data Type" - }, - "dtx": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Data Type Extra" - }, - "dtxp": { - "oneOf": [ - { - "$ref": "#/components/schemas/StringOrNull" - }, - { - "type": "number" - } - ], - "description": "Data Type Extra Precision" - }, - "dtxs": { - "oneOf": [ - { - "$ref": "#/components/schemas/StringOrNull" - }, - { - "type": "number" - } - ], - "description": "Data Type Extra Scale" - }, - "np": { - "oneOf": [ - { - "$ref": "#/components/schemas/StringOrNull" - }, - { - "type": "integer" - } - ], - "description": "Numeric Precision" - }, - "ns": { - "oneOf": [ - { - "$ref": "#/components/schemas/StringOrNull" - }, - { - "type": "integer" - } - ], - "description": "Numeric Scale" - }, - "pk": { - "$ref": "#/components/schemas/Bool", - "description": "Is this column a primary key?" - }, - "pv": { - "$ref": "#/components/schemas/Bool", - "description": "Is this column a primary value?" - }, - "rqd": { - "$ref": "#/components/schemas/Bool", - "description": "Is this column required?" - }, - "title": { - "maxLength": 255, - "type": "string", - "description": "Column Title" - }, - "uidt": { - "enum": [ - "Attachment", - "AutoNumber", - "Barcode", - "Button", - "Checkbox", - "Collaborator", - "Count", - "CreateTime", - "Currency", - "Date", - "DateTime", - "Decimal", - "Duration", - "Email", - "Formula", - "ForeignKey", - "GeoData", - "Geometry", - "ID", - "JSON", - "LastModifiedTime", - "LongText", - "LinkToAnotherRecord", - "Lookup", - "MultiSelect", - "Number", - "Percent", - "PhoneNumber", - "Rating", - "Rollup", - "SingleLineText", - "SingleSelect", - "SpecificDBType", - "Time", - "URL", - "Year", - "QrCode" - ], - "type": "string", - "description": "UI Data Type" - }, - "un": { - "$ref": "#/components/schemas/Bool", - "description": "Is this column unique?" - }, - "unique": { - "$ref": "#/components/schemas/Bool", - "description": "Is this column unique?" - } - }, - "title": "Normal Column Request Model", - "type": "object", - "required": ["column_name"], - "x-stoplight": { - "id": "b67hswwa49t9u" - } - }, - "OrgUserReq": { - "description": "Model for Organisation User Update Request", - "examples": [ - { - "email": "user@example.com", - "roles": "org-level-creator" - } - ], - "properties": { - "email": { - "format": "email", - "type": "string" - }, - "roles": { - "enum": ["org-level-creator", "org-level-viewer"], - "type": "string", - "description": "Roles for the project user" - } - }, - "title": "Organisation User Request Model", - "type": "object", - "x-stoplight": { - "id": "hs5aforkqjbkb" - } - }, - "Paginated": { - "description": "Model for Paginated", - "examples": [ - { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - ], - "properties": { - "isFirstPage": { - "description": "Is the current page the first page", - "type": "boolean" - }, - "isLastPage": { - "description": "Is the current page the last page", - "type": "boolean" - }, - "page": { - "description": "The current page", - "example": 1, - "type": "number" - }, - "pageSize": { - "description": "The number of pages", - "example": 10, - "type": "number" - }, - "totalRows": { - "description": "The number of rows in the given result", - "example": 1, - "type": "number" - } - }, - "title": "Paginated Model", - "type": "object", - "x-stoplight": { - "id": "ny0v2losvmitz" - } - }, - "Password": { - "description": "Model for Password", - "example": "password123456789", - "examples": ["password123456789"], - "minLength": 8, - "title": "Password Model", - "type": "string", - "x-stoplight": { - "id": "c6iocwuo2j8z8" - } - }, - "PasswordChangeReq": { - "description": "Model for Password Change Request", - "examples": [ - { - "currentPassword": "currentpassword", - "newPassword": "newpassword" - } - ], - "properties": { - "currentPassword": { - "type": "string" - }, - "newPassword": { - "minLength": 8, - "type": "string" - } - }, - "required": ["currentPassword", "newPassword"], - "title": "Password Change Request Model", - "type": "object", - "x-stoplight": { - "id": "99dogahvh0gla" - } - }, - "PasswordForgotReq": { - "description": "Model for Password Forgot Request", - "examples": [ - { - "email": "user@example.com" - } - ], - "properties": { - "email": { - "description": "Email address of the user", - "format": "email", - "type": "string" - } - }, - "required": ["email"], - "title": "Password Forgot Request Model", - "type": "object", - "x-stoplight": { - "id": "1kkft7m54ax45" - } - }, - "PasswordResetReq": { - "description": "Model for Password Reset Request", - "examples": [ - { - "password": "newpassword" - } - ], - "properties": { - "password": { - "description": "New password", - "example": "newpassword", - "minLength": 8, - "type": "string" - } - }, - "required": ["password"], - "title": "Password Reset Request Model", - "type": "object", - "x-stoplight": { - "id": "i3gzz403zjwh8" - } - }, - "Plugin": { - "description": "Model for Plugin", - "examples": [ - { - "id": "nc_tljibbzcyjrhcc", - "title": "S3", - "description": "Amazon Simple Storage Service (Amazon S3) is an object storage service that offers industry-leading scalability, data availability, security, and performance.", - "active": true, - "rating": null, - "version": "0.0.1", - "docs": null, - "status": "install", - "status_details": null, - "logo": "plugins/s3.png", - "icon": null, - "tags": "Storage", - "category": "Storage", - "input_schema": "{\"title\":\"Configure Amazon S3\",\"items\":[{\"key\":\"bucket\",\"label\":\"Bucket Name\",\"placeholder\":\"Bucket Name\",\"type\":\"SingleLineText\",\"required\":true},{\"key\":\"region\",\"label\":\"Region\",\"placeholder\":\"Region\",\"type\":\"SingleLineText\",\"required\":true},{\"key\":\"access_key\",\"label\":\"Access Key\",\"placeholder\":\"Access Key\",\"type\":\"SingleLineText\",\"required\":true},{\"key\":\"access_secret\",\"label\":\"Access Secret\",\"placeholder\":\"Access Secret\",\"type\":\"Password\",\"required\":true}],\"actions\":[{\"label\":\"Test\",\"placeholder\":\"Test\",\"key\":\"test\",\"actionType\":\"TEST\",\"type\":\"Button\"},{\"label\":\"Save\",\"placeholder\":\"Save\",\"key\":\"save\",\"actionType\":\"SUBMIT\",\"type\":\"Button\"}],\"msgOnInstall\":\"Successfully installed and attachment will be stored in AWS S3\",\"msgOnUninstall\":\"\"}", - "input": "{\"bucket\":\"my-bucket\",\"region\":\"us-west-004\",\"access_key\":\"redacted\",\"access_secret\":\"redacted\"}", - "creator": null, - "creator_website": null, - "price": null - } - ], - "title": "Plugin Model", - "type": "object", - "properties": { - "active": { - "$ref": "#/components/schemas/Bool", - "description": "Is plguin active?" - }, - "category": { - "type": "string", - "description": "Plugin Category", - "example": "Storage" - }, - "creator": { - "type": "string", - "description": "Plugin Creator (Not in use)" - }, - "creator_website": { - "type": "string", - "description": "Plugin Creator website (Not in use)" - }, - "description": { - "type": "string", - "description": "Plugin Description", - "example": "Amazon Simple Storage Service (Amazon S3) is an object storage service that offers industry-leading scalability, data availability, security, and performance." - }, - "docs": { - "type": "string", - "description": "Documentation of plugin (Not in use)" - }, - "icon": { - "type": "string", - "description": "Plugin Icon (Not in use)" - }, - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "input": { - "oneOf": [ - { - "$ref": "#/components/schemas/StringOrNull" - }, - { - "type": "integer" - } - ], - "description": "Plugin Input" - }, - "input_schema": { - "type": "string", - "description": "Plugin Input Schema\n" - }, - "logo": { - "type": "string", - "description": "Plugin logo", - "example": "plugins/s3.png" - }, - "price": { - "type": "string", - "description": "Plugin Price (Not in use)" - }, - "rating": { - "type": "number", - "description": "Plugin Rating (Not in use)" - }, - "status": { - "type": "string", - "description": "Plugin Status", - "example": "install" - }, - "status_details": { - "type": "string", - "description": "Not in use" - }, - "tags": { - "type": "string", - "description": "Plugin tags", - "example": "Storage" - }, - "title": { - "type": "string", - "description": "Plugin Title" - }, - "version": { - "type": "string", - "description": "Plugin Version", - "example": "0.0.1" - } - }, - "x-stoplight": { - "id": "uux5n95kbh2r5" - } - }, - "PluginReq": { - "description": "Model for Plugin Request", - "examples": [ - { - "active": 0, - "input": "{\"bucket\":\"my-bucket\",\"region\":\"us-west-004\",\"access_key\":\"redacted\",\"access_secret\":\"redacted\"}" - } - ], - "title": "Plugin Reqeust", - "type": "object", - "properties": { - "active": { - "$ref": "#/components/schemas/Bool", - "description": "Is Plugin Active?" - }, - "input": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Plugin Input" - } - }, - "x-stoplight": { - "id": "pci8zg4wgn3bx" - } - }, - "PluginTestReq": { - "description": "Model for Plugin Test Request", - "examples": [ - { - "title": "Plugin Foo", - "input": "{\"bucket\":\"my-bucket\",\"region\":\"us-west-004\",\"access_key\":\"redacted\",\"access_secret\":\"redacted\"}", - "category": "Email" - } - ], - "title": "Plugin Test Request Model", - "type": "object", - "properties": { - "title": { - "maxLength": 45, - "type": "string", - "description": "Plugin Title" - }, - "input": { - "oneOf": [ - { - "type": "string", - "description": "Plugin Input as JSON string" - }, - { - "description": "Plugin Input", - "type": "object" - } - ] - }, - "category": { - "x-stoplight": { - "id": "rg3i3ov9rs6d0" - }, - "type": "string", - "example": "Email" - } - }, - "required": ["title", "input", "category"], - "x-stoplight": { - "id": "gest5kbecpjdi" - } - }, - "Project": { - "description": "Model for Project", - "examples": [ - { - "bases": [ - { - "alias": "string", - "config": null, - "enabled": true, - "id": "string", - "inflection_column": "camelize", - "inflection_table": "camelize", - "is_meta": true, - "order": 1, - "project_id": "string", - "type": "mysql2", - "updated_at": "2023-03-01 14:27:36" - } - ], - "color": "#24716E", - "created_at": "2023-03-01 14:27:36", - "deleted": true, - "description": "This is my project description", - "id": "p_124hhlkbeasewh", - "is_meta": true, - "meta": {}, - "order": 0, - "prefix": "nc_vm5q__", - "status": "string", - "title": "my-project" - } - ], - "title": "Project Model", - "type": "object", - "properties": { - "bases": { - "description": "List of base models", - "type": "array", - "items": { - "$ref": "#/components/schemas/Base" - } - }, - "color": { - "description": "Primary Theme Color", - "example": "#24716E", - "type": "string" - }, - "deleted": { - "$ref": "#/components/schemas/Bool", - "description": "Is the project deleted" - }, - "description": { - "description": "Project Description", - "example": "This is my project description", - "type": "string" - }, - "id": { - "description": "Unique Project ID", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "is_meta": { - "$ref": "#/components/schemas/Bool" - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "description": "Meta Info such as theme colors" - }, - "order": { - "description": "The order in project list", - "type": "number" - }, - "prefix": { - "description": "Project prefix. Used in XCDB only.", - "example": "nc_vm5q__", - "type": "string" - }, - "status": { - "type": "string" - }, - "title": { - "description": "Project Title", - "example": "my-project", - "type": "string" - } - }, - "x-stoplight": { - "id": "gae6rj3whdnj9" - } - }, - "ProjectList": { - "description": "Model for Project List", - "examples": [ - { - "list": [ - { - "bases": [ - { - "alias": "string", - "config": null, - "created_at": "2023-03-01 14:27:36", - "enabled": true, - "id": "string", - "inflection_column": "camelize", - "inflection_table": "camelize", - "is_meta": true, - "order": 1, - "project_id": "string", - "type": "mysql2", - "updated_at": "2023-03-01 14:27:36" - } - ], - "color": "#24716E", - "created_at": "2023-03-01 14:27:36", - "deleted": true, - "description": "This is my project description", - "id": "p_124hhlkbeasewh", - "is_meta": true, - "meta": {}, - "order": 0, - "prefix": "nc_vm5q__", - "status": "string", - "title": "my-project", - "updated_at": "2023-03-01 14:27:36" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - ], - "title": "Project List Model", - "type": "object", - "x-examples": { - "example-1": { - "bases": { - "list": [ - { - "alias": "string", - "database": "string", - "host": "string", - "id": "string", - "params": "string", - "password": "string", - "port": 0, - "project_id": "string", - "ssl": "string", - "type": "string", - "url": "string", - "username": "string" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "pageSize": 0, - "sort": "string", - "totalRows": 0 - } - } - } - }, - "properties": { - "list": { - "description": "List of Project Models", - "minItems": 1, - "type": "array", - "uniqueItems": true, - "items": { - "$ref": "#/components/schemas/Project" - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated", - "description": "Pagination Info" - } - }, - "required": ["list", "pageInfo"], - "x-stoplight": { - "id": "xbosckfm1h9l0" - } - }, - "ProjectReq": { - "description": "Model for Project Request", - "examples": [ - { - "bases": [ - { - "alias": "My Base", - "config": null, - "inflection_column": "camelize", - "inflection_table": "camelize", - "is_meta": true, - "type": "mysql" - } - ], - "color": "#24716E", - "description": "This is my project description", - "title": "My Project" - } - ], - "properties": { - "bases": { - "description": "Array of Bases", - "items": { - "$ref": "#/components/schemas/BaseReq" - }, - "type": "array" - }, - "color": { - "description": "Primary Theme Color", - "example": "#24716E", - "maxLength": 50, - "type": "string" - }, - "description": { - "description": "Project Description", - "example": "This is my project description", - "type": "string" - }, - "title": { - "description": "Project Title", - "example": "My Project", - "maxLength": 128, - "minLength": 1, - "type": "string" - } - }, - "required": ["title"], - "title": "Project Request Model", - "type": "object", - "x-stoplight": { - "id": "aicbp4keo57ld" - } - }, - "ProjectUpdateReq": { - "description": "Model for Project Update Request", - "x-stoplight": { - "id": "83257b35r118q" - }, - "examples": [ - { - "color": "#24716E", - "meta": null, - "title": "My Project" - } - ], - "title": "Project Update Request Model", - "type": "object", - "properties": { - "color": { - "description": "Primary Theme Color", - "example": "#24716E", - "maxLength": 50, - "type": "string" - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "description": "Project Meta", - "x-stoplight": { - "id": "m05w9sbwqgul3" - } - }, - "title": { - "description": "Project Title", - "example": "My Project", - "maxLength": 128, - "minLength": 1, - "type": "string" - } - } - }, - "ProjectUserReq": { - "description": "Model for Project User Request", - "examples": [ - { - "email": "user@example.com", - "roles": "owner" - } - ], - "title": "Project User Request Model", - "type": "object", - "properties": { - "email": { - "format": "email", - "type": "string", - "description": "Project User Email" - }, - "roles": { - "enum": [ - "commenter", - "editor", - "guest", - "owner", - "viewer", - "creator" - ], - "type": "string", - "description": "Project User Role" - } - }, - "required": ["email", "roles"], - "x-stoplight": { - "id": "tq2wpd2agebjz" - } - }, - "Rollup": { - "description": "Model for Rollup", - "examples": [ - { - "id": "rl_kc19pbdkij8wly", - "fk_column_id": "cl_588b63mneri2yi", - "fk_relation_column_id": "cl_c09q6eu6hsvn4s", - "fk_rollup_column_id": "cl_m62i1vyl23n8co", - "rollup_function": "count" - } - ], - "title": "Rollup Model", - "type": "object", - "properties": { - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "fk_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Column" - }, - "fk_relation_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign to Relation Column" - }, - "fk_rollup_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign to Rollup Column" - }, - "rollup_function": { - "type": "string", - "description": "Rollup Function", - "example": "count", - "enum": [ - "count", - "min", - "max", - "avg", - "countDistinct", - "sumDistinct", - "avgDistinct" - ] - } - }, - "x-stoplight": { - "id": "vdzh0qojyn9a9" - } - }, - "RollupColumnReq": { - "description": "Model for Rollup Column Request", - "examples": [ - { - "fk_relation_column_id": "cl_c09q6eu6hsvn4s", - "fk_rollup_column_id": "cl_m62i1vyl23n8co", - "title": "Rollup Column", - "rollup_function": "avg", - "uidt": "Rollup" - } - ], - "title": "Rollup Column Request Model", - "type": "object", - "properties": { - "fk_relation_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Relation Column" - }, - "fk_rollup_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Rollup Column" - }, - "title": { - "maxLength": 255, - "type": "string", - "description": "Rollup Column Title" - }, - "rollup_function": { - "enum": [ - "avg", - "avgDistinct", - "count", - "countDistinct", - "max", - "min", - "sum", - "sumDistinct" - ], - "type": "string", - "description": "Rollup Function" - }, - "uidt": { - "enum": ["Rollup"], - "type": "string", - "description": "UI DataType" - } - }, - "x-stoplight": { - "id": "uw9fq6lp1lone" - } - }, - "SelectOption": { - "description": "Model for SelectOption", - "examples": [ - { - "id": "sl_hvfeuagqtlzzbk", - "title": "Option A", - "fk_column_id": "cl_35zmvi2tezfipw", - "color": "#cfdffe", - "order": 1 - } - ], - "title": "SelectOption Model", - "type": "object", - "properties": { - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "title": { - "type": "string", - "description": "Option Title\n", - "example": "Option A" - }, - "fk_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Column" - }, - "color": { - "type": "string", - "description": "Option Color", - "example": "#cfdffe" - }, - "order": { - "type": "number", - "description": "The order among the options", - "example": 1 - } - }, - "x-stoplight": { - "id": "onnh5qie1ul32" - } - }, - "SelectOptions": { - "description": "Model for SelectOptions", - "examples": [ - { - "options": [ - { - "id": "sl_hvfeuagqtlzzbk", - "title": "Option A", - "fk_column_id": "cl_35zmvi2tezfipw", - "color": "#cfdffe", - "order": 1 - } - ] - } - ], - "title": "SelectOptions Model", - "type": "object", - "properties": { - "options": { - "type": "array", - "description": "Array of select options", - "items": { - "$ref": "#/components/schemas/SelectOption" - } - } - }, - "required": ["options"], - "x-stoplight": { - "id": "3i68n0spduuf9" - } - }, - "SharedBaseReq": { - "description": "Model for Shared Base Request", - "examples": [ - { - "password": "password123", - "roles": "editor" - } - ], - "title": "Shared Base Request Model", - "type": "object", - "properties": { - "password": { - "minLength": 8, - "type": "string", - "description": "Password to protect the base", - "example": "password123" - }, - "roles": { - "enum": ["commenter", "editor", "viewer"], - "type": "string", - "description": "The role given the target user", - "example": "editor" - } - }, - "x-stoplight": { - "id": "ep7ikmx3sudcl" - } - }, - "SharedView": { - "$ref": "#/components/schemas/View", - "description": "Model for Shared View", - "title": "SharedView", - "examples": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:46:31", - "fk_model_id": "md_mhs9z4r2ak98x0", - "id": "vw_lg052cnc1c26kf", - "is_default": 1, - "lock_type": "collaborative", - "meta": {}, - "order": 1, - "password": null, - "project_id": "p_xm3thidrblw4n7", - "show": 1, - "show_system_fields": null, - "title": "Sheet-1", - "type": 3, - "updated_at": "2023-03-02 17:46:31", - "uuid": null, - "view": { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:46:31", - "fk_view_id": "vw_lg052cnc1c26kf", - "meta": null, - "project_id": "p_xm3thidrblw4n7", - "row_height": null, - "updated_at": "2023-03-02 17:46:31", - "uuid": null - } - } - ], - "x-stoplight": { - "id": "fqfohevz2zj4u" - } - }, - "SharedViewList": { - "description": "Model for Shared View List", - "examples": [ - { - "list": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:46:31", - "fk_model_id": "md_mhs9z4r2ak98x0", - "id": "vw_lg052cnc1c26kf", - "is_default": 1, - "lock_type": "collaborative", - "meta": {}, - "order": 1, - "password": null, - "project_id": "p_xm3thidrblw4n7", - "show": 1, - "show_system_fields": null, - "title": "Sheet-1", - "type": 3, - "updated_at": "2023-03-02 17:46:31", - "uuid": null, - "view": { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:46:31", - "fk_view_id": "vw_lg052cnc1c26kf", - "meta": null, - "project_id": "p_xm3thidrblw4n7", - "row_height": null, - "updated_at": "2023-03-02 17:46:31", - "uuid": null - } - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - ], - "title": "Shared View List Model", - "type": "object", - "x-examples": { - "example-1": { - "bases": { - "list": [ - { - "alias": "string", - "database": "string", - "host": "string", - "id": "string", - "params": "string", - "password": "string", - "port": 0, - "project_id": "string", - "ssl": "string", - "type": "string", - "url": "string", - "username": "string" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "pageSize": 0, - "sort": "string", - "totalRows": 0 - } - } - } - }, - "properties": { - "list": { - "minItems": 1, - "type": "array", - "uniqueItems": true, - "description": "List of shared view objects", - "items": { - "$ref": "#/components/schemas/SharedView" - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated", - "description": "Paginated Info" - } - }, - "required": ["list", "pageInfo"], - "x-stoplight": { - "id": "zdpekhmw0wvj3" - } - }, - "SharedViewReq": { - "description": "Model for Shared View Request", - "examples": [ - { - "meta": {}, - "password": "123456789" - } - ], - "title": "Shared View Request Model", - "type": "object", - "properties": { - "meta": { - "$ref": "#/components/schemas/Meta", - "description": "Meta data passing to Shared View such as if download is allowed or not." - }, - "password": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Password to restrict access" - } - }, - "x-stoplight": { - "id": "0g3o2uo9y4h4g" - } - }, - "SignInReq": { - "description": "Model for Signin Request", - "examples": [ - { - "email": "user@example.com", - "password": "string" - } - ], - "properties": { - "email": { - "description": "Email address of the user", - "format": "email", - "type": "string" - }, - "password": { - "description": "Password of the user", - "type": "string" - } - }, - "required": ["email", "password"], - "title": "Signin Request Model", - "type": "object", - "x-stoplight": { - "id": "dxxafjky40cz1" - } - }, - "SignUpReq": { - "description": "Model for Signup Request", - "examples": [ - { - "email": "user@example.com", - "password": "password123456789", - "firstname": "Alice", - "lastname": "Smith", - "token": null, - "ignore_subscribe": 0 - } - ], - "title": "Signup Request Model", - "type": "object", - "properties": { - "email": { - "description": "Email address of the user", - "example": "user@example.com", - "format": "email", - "type": "string" - }, - "password": { - "description": "Password of the user", - "example": "password123456789", - "minLength": 8, - "type": "string" - }, - "firstname": { - "$ref": "#/components/schemas/StringOrNull", - "x-stoplight": { - "id": "lblivgs8wcsm1" - } - }, - "lastname": { - "$ref": "#/components/schemas/StringOrNull", - "x-stoplight": { - "id": "d4341r35tucq3" - } - }, - "token": { - "$ref": "#/components/schemas/StringOrNull", - "x-stoplight": { - "id": "otw9jgnr9n7c4" - }, - "description": "Sign Up Token. Used for invitation." - }, - "ignore_subscribe": { - "$ref": "#/components/schemas/Bool", - "x-stoplight": { - "id": "g7ge6mc6vdsds" - }, - "description": "Ignore Subscription" - } - }, - "required": ["email", "password"], - "x-stoplight": { - "id": "2rcbk0flkc4yu" - } - }, - "Sort": { - "description": "Model for Sort", - "examples": [ - { - "id": "so_xd4t51uv60ghzl", - "fk_column_id": "cl_l11b769pe2j1ce", - "fk_model_id": "md_ehn5izr99m7d45", - "base_id": "ds_3l9qx8xqksenrl", - "direction": "desc", - "order": 1, - "project_id": "p_9sx43moxhqtjm3" - } - ], - "title": "Sort Model", - "type": "object", - "properties": { - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "fk_column_id": { - "$ref": "#/components/schemas/Id" - }, - "fk_model_id": { - "$ref": "#/components/schemas/Id" - }, - "base_id": { - "type": "string", - "description": "Base ID", - "example": "ds_3l9qx8xqksenrl", - "readOnly": true - }, - "direction": { - "type": "string", - "description": "Sort direction", - "enum": ["asc", "desc"], - "example": "desc" - }, - "order": { - "type": "number", - "example": 1 - }, - "project_id": { - "type": "string", - "description": "Project ID", - "example": "p_9sx43moxhqtjm3", - "readOnly": true - } - }, - "x-stoplight": { - "id": "3jjbe2mjzy5li" - } - }, - "SortList": { - "description": "Model for Sort List", - "examples": [ - { - "list": [ - { - "id": "so_xd4t51uv60ghzl", - "fk_column_id": "cl_l11b769pe2j1ce", - "fk_model_id": "md_ehn5izr99m7d45", - "base_id": "ds_3l9qx8xqksenrl", - "direction": "desc", - "order": 1, - "project_id": "p_9sx43moxhqtjm3" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - ], - "title": "Sort List Model", - "type": "object", - "x-examples": { - "example-1": { - "bases": { - "list": [ - { - "alias": "string", - "database": "string", - "host": "string", - "id": "string", - "params": "string", - "password": "string", - "port": 0, - "project_id": "string", - "ssl": "string", - "type": "string", - "url": "string", - "username": "string" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "pageSize": 0, - "sort": "string", - "totalRows": 0 - } - } - } - }, - "properties": { - "list": { - "type": "array", - "x-stoplight": { - "id": "gjqqc8ciqg947" - }, - "description": "List of Sort Objects", - "items": { - "$ref": "#/components/schemas/Sort", - "x-stoplight": { - "id": "usnfa1kbovpmb" - } - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated", - "x-stoplight": { - "id": "i75wcejfp5mnq" - } - } - }, - "required": ["list", "pageInfo"], - "x-stoplight": { - "id": "fsq6d3pi8b3iz" - } - }, - "SortReq": { - "description": "Model for Sort Request", - "examples": [ - { - "direction": "asc", - "fk_column_id": "cl_l11b769pe2j1ce" - } - ], - "minProperties": 1, - "title": "Sort Request Model", - "type": "object", - "properties": { - "fk_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Column" - }, - "direction": { - "description": "Sort direction", - "enum": ["asc", "desc"], - "type": "string" - } - }, - "x-stoplight": { - "id": "lao7jfow2dbe7" - } - }, - "StringOrNull": { - "description": "Model for StringOrNull", - "examples": ["string"], - "oneOf": [ - { - "maxLength": 255, - "type": "string" - }, - { - "type": "null" - } - ], - "title": "StringOrNull Model", - "x-stoplight": { - "id": "xh9dwrizrvfh6" - } - }, - "Table": { - "description": "Model for Table", - "examples": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "columns": [ - { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": "CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP", - "clen": null, - "column_name": "updated_at", - "cop": "4", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "timestamp", - "deleted": null, - "dt": "timestamp", - "dtx": "specificType", - "dtxp": "0", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_m4wkaqgqqjzoeh", - "meta": null, - "np": null, - "ns": null, - "order": 4, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 0, - "system": 0, - "title": "UpdatedAt", - "uidt": "DateTime", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": "CURRENT_TIMESTAMP", - "clen": null, - "column_name": "created_at", - "cop": "3", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "timestamp", - "deleted": null, - "dt": "timestamp", - "dtx": "specificType", - "dtxp": "0", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_jpl0qu4gj4rexq", - "meta": null, - "np": null, - "ns": null, - "order": 3, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 0, - "system": 0, - "title": "CreatedAt", - "uidt": "DateTime", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": null, - "clen": "45", - "column_name": "title", - "cop": "2", - "created_at": "2023-03-02 17:04:06", - "csn": "utf8mb4", - "ct": "varchar(45)", - "deleted": null, - "dt": "varchar", - "dtx": "specificType", - "dtxp": "45", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_c5knoi4xs4sfpt", - "meta": null, - "np": null, - "ns": null, - "order": 2, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": 1, - "rqd": 0, - "system": 0, - "title": "Title", - "uidt": "SingleLineText", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - { - "ai": 1, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": null, - "clen": null, - "column_name": "id", - "cop": "1", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "int unsigned", - "deleted": null, - "dt": "int", - "dtx": "specificType", - "dtxp": "", - "dtxs": "0", - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_phvuuwjrzcdo0g", - "meta": null, - "np": "10", - "ns": "0", - "order": 1, - "pk": 1, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 1, - "system": 0, - "title": "Id", - "uidt": "ID", - "un": 1, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - } - ], - "columnsById": { - "cl_c5knoi4xs4sfpt": { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": null, - "clen": "45", - "column_name": "title", - "cop": "2", - "created_at": "2023-03-02 17:04:06", - "csn": "utf8mb4", - "ct": "varchar(45)", - "deleted": null, - "dt": "varchar", - "dtx": "specificType", - "dtxp": "45", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_c5knoi4xs4sfpt", - "meta": null, - "np": null, - "ns": null, - "order": 2, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": 1, - "rqd": 0, - "system": 0, - "title": "Title", - "uidt": "SingleLineText", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - "cl_jpl0qu4gj4rexq": { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": "CURRENT_TIMESTAMP", - "clen": null, - "column_name": "created_at", - "cop": "3", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "timestamp", - "deleted": null, - "dt": "timestamp", - "dtx": "specificType", - "dtxp": "0", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_jpl0qu4gj4rexq", - "meta": null, - "np": null, - "ns": null, - "order": 3, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 0, - "system": 0, - "title": "CreatedAt", - "uidt": "DateTime", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - "cl_m4wkaqgqqjzoeh": { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": "CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP", - "clen": null, - "column_name": "updated_at", - "cop": "4", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "timestamp", - "deleted": null, - "dt": "timestamp", - "dtx": "specificType", - "dtxp": "0", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_m4wkaqgqqjzoeh", - "meta": null, - "np": null, - "ns": null, - "order": 4, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 0, - "system": 0, - "title": "UpdatedAt", - "uidt": "DateTime", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - "cl_phvuuwjrzcdo0g": { - "ai": 1, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": null, - "clen": null, - "column_name": "id", - "cop": "1", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "int unsigned", - "deleted": null, - "dt": "int", - "dtx": "specificType", - "dtxp": "", - "dtxs": "0", - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_phvuuwjrzcdo0g", - "meta": null, - "np": "10", - "ns": "0", - "order": 1, - "pk": 1, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 1, - "system": 0, - "title": "Id", - "uidt": "ID", - "un": 1, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - } - }, - "created_at": "2023-03-02 17:04:06", - "deleted": null, - "enabled": 1, - "id": "md_rsu68aqjsbyqtl", - "meta": null, - "mm": 0, - "order": 1, - "pinned": null, - "project_id": "p_xm3thidrblw4n7", - "schema": null, - "table_name": "nc_vm5q___Table1", - "tags": null, - "title": "Table1", - "type": "table", - "updated_at": "2023-03-02 17:04:08", - "views": [ - { - "_ptn": "Table1", - "_tn": "Table1", - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:04:06", - "disabled": { - "commenter": false, - "creator": false, - "editor": false, - "guest": false, - "owner": false, - "viewer": false - }, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "vw_p2jcatxz4mvcfw", - "is_default": 1, - "lock_type": "collaborative", - "meta": {}, - "order": 1, - "password": null, - "project_id": "p_xm3thidrblw4n7", - "ptn": "nc_vm5q___Table1", - "ptype": "table", - "show": 1, - "show_system_fields": null, - "table_meta": null, - "title": "Table1", - "tn": "Table1", - "type": 3, - "updated_at": "2023-03-02 17:04:06", - "uuid": null, - "view": { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:04:06", - "fk_view_id": "vw_p2jcatxz4mvcfw", - "meta": null, - "project_id": "p_xm3thidrblw4n7", - "row_height": null, - "updated_at": "2023-03-02 17:04:06", - "uuid": null - } - } - ] - } - ], - "title": "Table Model", - "type": "object", - "properties": { - "base_id": { - "description": "Unique Base ID", - "type": "string" - }, - "columns": { - "description": "The columns included in this table", - "type": "array", - "items": { - "$ref": "#/components/schemas/Column" - } - }, - "columnsById": { - "description": "Column Models grouped by IDs", - "type": "object" - }, - "deleted": { - "$ref": "#/components/schemas/Bool" - }, - "enabled": { - "$ref": "#/components/schemas/Bool", - "description": "Is this table enabled?" - }, - "id": { - "description": "Unique Table ID", - "type": "string" - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "description": "Meta Data" - }, - "mm": { - "$ref": "#/components/schemas/Bool", - "description": "Is this table used for M2M" - }, - "order": { - "description": "The order of the list of tables", - "type": "number" - }, - "pinned": { - "$ref": "#/components/schemas/Bool", - "description": "Currently not in use" - }, - "project_id": { - "description": "Unique Project ID", - "type": "string" - }, - "table_name": { - "description": "Table Name. Prefix will be added for XCDB projects.", - "type": "string" - }, - "tags": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Currently not in use" - }, - "title": { - "description": "Table Title", - "type": "string" - }, - "type": { - "description": "Table Type", - "type": "string" - } - }, - "required": ["table_name", "title"], - "x-stoplight": { - "id": "rvdu5okgpz1xk" - } - }, - "TableList": { - "description": "Model for Table List", - "examples": [ - { - "list": [ - { - "alias": "string", - "base_id": "string", - "column": [ - { - "alias": "string", - "auto_increment": true, - "auto_update_timestamp": true, - "base_id": "string", - "character_maximum_length": "string", - "character_set_name": "string", - "colOptions": { - "deleted": "string", - "dr": "string", - "fk_child_column_id": "string", - "fk_column_id": "string", - "fk_index_name": "string", - "fk_mm_child_column_id": "string", - "fk_mm_model_id": "string", - "fk_mm_parent_column_id": "string", - "fk_parent_column_id": "string", - "id": "string", - "order": "string", - "type": "string", - "ur": "string", - "virtual": true - }, - "column_comment": "string", - "column_default": "string", - "column_ordinal_position": "string", - "column_type": "string", - "data_type": "string", - "data_type_x": "string", - "data_type_x_precision": "string", - "data_type_x_scale": "string", - "deleted": true, - "fk_model_id": "string", - "id": "string", - "numeric_precision": "string", - "numeric_scale": "string", - "order": 0, - "primary_key": true, - "primary_value": true, - "rqd": "string", - "title": "string", - "ui_data_type": "string", - "un": "string", - "unique": true, - "visible": true - } - ], - "columnByIds": {}, - "deleted": true, - "enabled": true, - "id": "string", - "order": 0, - "parent_id": "string", - "pinned": true, - "project_id": "string", - "show_as": "string", - "tags": "string", - "title": "string", - "type": "string" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - ], - "title": "Table List Model", - "type": "object", - "x-examples": { - "example-1": { - "bases": { - "list": [ - { - "alias": "string", - "database": "string", - "host": "string", - "id": "string", - "params": "string", - "password": "string", - "port": 0, - "project_id": "string", - "ssl": "string", - "type": "string", - "url": "string", - "username": "string" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "pageSize": 0, - "sort": "string", - "totalRows": 0 - } - } - } - }, - "properties": { - "list": { - "minItems": 1, - "type": "array", - "uniqueItems": true, - "description": "List of table objects", - "items": { - "$ref": "#/components/schemas/Table" - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated", - "description": "Paginated Info" - } - }, - "required": ["list", "pageInfo"], - "x-stoplight": { - "id": "25z7dodhqs3lc" - } - }, - "TableReq": { - "description": "Model for Table Request", - "examples": [ - { - "columns": [ - { - "ai": false, - "altered": 1, - "cdf": "CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP", - "ck": false, - "clen": 45, - "column_name": "updated_at", - "ct": "varchar(45)", - "dt": "timestamp", - "dtx": "specificType", - "dtxp": "", - "dtxs": "", - "np": null, - "nrqd": true, - "ns": null, - "pk": false, - "rqd": false, - "title": "UpdatedAt", - "uicn": "", - "uidt": "DateTime", - "uip": "", - "un": false - }, - { - "ai": false, - "altered": 1, - "cdf": "CURRENT_TIMESTAMP", - "ck": false, - "clen": 45, - "column_name": "created_at", - "ct": "varchar(45)", - "dt": "timestamp", - "dtx": "specificType", - "dtxp": "", - "dtxs": "", - "np": null, - "nrqd": true, - "ns": null, - "pk": false, - "rqd": false, - "title": "CreatedAt", - "uicn": "", - "uidt": "DateTime", - "uip": "", - "un": false - }, - { - "ai": false, - "altered": 1, - "cdf": null, - "ck": false, - "clen": 45, - "column_name": "title", - "ct": "varchar(45)", - "dt": "varchar", - "dtx": "specificType", - "dtxp": "45", - "dtxs": "", - "np": null, - "nrqd": true, - "ns": null, - "pk": false, - "rqd": false, - "title": "Title", - "uicn": "", - "uidt": "SingleLineText", - "uip": "", - "un": false - }, - { - "ai": true, - "altered": 1, - "cdf": null, - "ck": false, - "clen": null, - "column_name": "id", - "ct": "int(11)", - "dt": "int", - "dtx": "integer", - "dtxp": "11", - "dtxs": "", - "np": 11, - "nrqd": false, - "ns": 0, - "pk": true, - "rqd": true, - "title": "Id", - "uicn": "", - "uidt": "ID", - "uip": "", - "un": true - } - ], - "table_name": "Sheet-1", - "title": "Sheet-1" - } - ], - "properties": { - "columns": { - "description": "The column models in this table", - "items": { - "$ref": "#/components/schemas/NormalColumnRequest" - }, - "type": "array" - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "description": "the meta data for this table" - }, - "order": { - "description": "The order of table list", - "example": 1, - "type": "number" - }, - "table_name": { - "description": "Table name", - "example": "my_table", - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "title": { - "description": "Table title", - "example": "My Table", - "maxLength": 255, - "minLength": 0, - "type": "string" - } - }, - "required": ["columns", "table_name"], - "title": "Table Request Model", - "type": "object", - "x-stoplight": { - "id": "kilqakhuuzstv" - } - }, - "User": { - "description": "Model for User", - "examples": [ - { - "email": "user@example.com", - "email_verified": true, - "firstname": "Alice", - "id": "us_8kugj628ebjngs", - "lastname": "Smith", - "roles": "org-level-viewer" - } - ], - "title": "User Model", - "type": "object", - "x-internal": false, - "properties": { - "email": { - "description": "The email of the user", - "example": "user@example.com", - "format": "email", - "type": "string" - }, - "email_verified": { - "description": "Set to true if the user's email has been verified.", - "type": "boolean" - }, - "firstname": { - "description": "The first name of the user", - "example": "Alice", - "type": "string" - }, - "id": { - "description": "Unique identifier for the given user.", - "example": "us_8kugj628ebjngs", - "type": "string" - }, - "lastname": { - "description": "The last name of the user", - "example": "Smith", - "type": "string" - }, - "roles": { - "description": "The roles of the user", - "example": "org-level-viewer", - "type": "string" - } - }, - "required": ["email", "email_verified", "firstname", "id", "lastname"], - "x-stoplight": { - "id": "nwug6wvbc5yrp" - } - }, - "UserInfo": { - "description": "Model for User Info", - "examples": [ - { - "email": "user@example.com", - "email_verified": true, - "firstname": "string", - "id": "string", - "lastname": "string", - "roles": null - } - ], - "properties": { - "email": { - "description": "User Email", - "format": "email", - "type": "string" - }, - "email_verified": { - "description": "Set to true if the user's email has been verified.", - "type": "boolean" - }, - "firstname": { - "description": "The firstname of the user", - "type": "string" - }, - "id": { - "description": "User ID", - "type": "string" - }, - "lastname": { - "description": "The lastname of the user", - "type": "string" - }, - "roles": { - "description": "The roles of the user" - } - }, - "title": "User Info Model", - "type": "object", - "x-stoplight": { - "id": "qravubcoxvr6x" - } - }, - "UserList": { - "description": "Model for User List", - "examples": [ - { - "list": [ - { - "email": "user@example.com", - "email_verified": true, - "firstname": "Alice", - "id": "us_8kugj628ebjngs", - "lastname": "Smith", - "roles": "org-level-viewer" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - ], - "title": "User List Model", - "type": "object", - "x-examples": { - "example-1": { - "bases": { - "list": [ - { - "alias": "string", - "database": "string", - "host": "string", - "id": "string", - "params": "string", - "password": "string", - "port": 0, - "project_id": "string", - "ssl": "string", - "type": "string", - "url": "string", - "username": "string" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "pageSize": 0, - "sort": "string", - "totalRows": 0 - } - } - } - }, - "properties": { - "list": { - "type": "array", - "x-stoplight": { - "id": "8o7v47q3e67ef" - }, - "description": "List of user objects", - "items": { - "$ref": "#/components/schemas/User", - "x-stoplight": { - "id": "kwqzxwea9r5er" - } - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated", - "x-stoplight": { - "id": "0d98n6sfxfvft" - }, - "description": "Paginated Info" - } - }, - "required": ["list", "pageInfo"], - "x-stoplight": { - "id": "11epslmm9jcga" - } - }, - "View": { - "description": "Model for View", - "examples": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:46:31", - "fk_model_id": "md_mhs9z4r2ak98x0", - "id": "vw_lg052cnc1c26kf", - "is_default": 1, - "lock_type": "collaborative", - "meta": {}, - "order": 1, - "password": null, - "project_id": "p_xm3thidrblw4n7", - "show": 1, - "show_system_fields": null, - "title": "Sheet-1", - "type": 3, - "updated_at": "2023-03-02 17:46:31", - "uuid": null, - "view": { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:46:31", - "fk_view_id": "vw_lg052cnc1c26kf", - "meta": null, - "project_id": "p_xm3thidrblw4n7", - "row_height": null, - "updated_at": "2023-03-02 17:46:31", - "uuid": null - } - } - ], - "title": "View Model", - "type": "object", - "properties": { - "base_id": { - "$ref": "#/components/schemas/Id", - "description": "Unique Base ID" - }, - "fk_model_id": { - "$ref": "#/components/schemas/Id", - "description": "Unique Model ID" - }, - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID for View" - }, - "lock_type": { - "description": "Lock Type of the view", - "enum": ["collaborative", "locked", "personal"], - "type": "string" - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "description": "Meta data for this view" - }, - "order": { - "description": "The rder of the list of views", - "type": "number" - }, - "password": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Password for protecting the view" - }, - "project_id": { - "$ref": "#/components/schemas/Id", - "description": "Unique Project ID" - }, - "show": { - "$ref": "#/components/schemas/Bool", - "description": "If this view is shown?" - }, - "show_system_fields": { - "$ref": "#/components/schemas/Bool", - "description": "Should show system fields in this view?" - }, - "is_default": { - "$ref": "#/components/schemas/Bool", - "description": "Is this view default view for the model?" - }, - "title": { - "description": "View Title", - "type": "string" - }, - "type": { - "description": "View Type", - "type": "number" - }, - "uuid": { - "$ref": "#/components/schemas/StringOrNull", - "description": "UUID of the view" - }, - "view": { - "anyOf": [ - { - "$ref": "#/components/schemas/Form" - }, - { - "$ref": "#/components/schemas/Gallery" - }, - { - "$ref": "#/components/schemas/Grid" - }, - { - "$ref": "#/components/schemas/Kanban" - }, - { - "$ref": "#/components/schemas/Map" - } - ], - "description": "Associated View Model" - } - }, - "required": ["fk_model_id", "show", "title", "type"], - "x-stoplight": { - "id": "pbahdgaroikdz" - } - }, - "ViewList": { - "description": "Model for View List", - "examples": [ - { - "list": [ - { - "alias": "string", - "column": [ - { - "alias": "string", - "auto_increment": true, - "auto_update_timestamp": true, - "base_id": "string", - "character_maximum_length": "string", - "character_set_name": "string", - "colOptions": { - "deleted": "string", - "dr": "string", - "fk_child_column_id": "string", - "fk_column_id": "string", - "fk_index_name": "string", - "fk_mm_child_column_id": "string", - "fk_mm_model_id": "string", - "fk_mm_parent_column_id": "string", - "fk_parent_column_id": "string", - "id": "string", - "order": "string", - "type": "string", - "ur": "string", - "virtual": true - }, - "column_comment": "string", - "column_default": "string", - "column_ordinal_position": "string", - "column_type": "string", - "data_type": "string", - "data_type_x": "string", - "data_type_x_precision": "string", - "data_type_x_scale": "string", - "deleted": true, - "fk_model_id": "string", - "id": "string", - "numeric_precision": "string", - "numeric_scale": "string", - "order": 0, - "primary_key": true, - "primary_value": true, - "rqd": "string", - "title": "string", - "ui_data_type": "string", - "un": "string", - "unique": true, - "visible": true - } - ], - "columnByIds": {}, - "deleted": true, - "enabled": true, - "fk_base_id": "string", - "fk_project_id": "string", - "id": "string", - "order": 0, - "parent_id": "string", - "pinned": true, - "show_as": "string", - "tags": "string", - "title": "string", - "type": "string" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - ], - "title": "View List Model", - "type": "object", - "x-examples": { - "example-1": { - "bases": { - "list": [ - { - "alias": "string", - "database": "string", - "host": "string", - "id": "string", - "params": "string", - "password": "string", - "port": 0, - "project_id": "string", - "ssl": "string", - "type": "string", - "url": "string", - "username": "string" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "pageSize": 0, - "sort": "string", - "totalRows": 0 - } - } - } - }, - "properties": { - "list": { - "type": "array", - "description": "List of view objects", - "items": { - "$ref": "#/components/schemas/View" - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated", - "description": "Paginated Info" - } - }, - "required": ["list", "pageInfo"], - "x-stoplight": { - "id": "5wwtppugkhbeh" - } - }, - "ViewCreateReq": { - "type": "object", - "x-stoplight": { - "id": "lksv99846uy60" - }, - "title": "ViewCreateReq", - "description": "Model for View Create Request", - "examples": [ - { - "title": "My Grid View", - "type": 3, - "copy_from_id": null, - "fk_grp_col_id": null, - "fk_geo_data_col_id": null - }, - { - "title": "My Gallery View", - "type": 2, - "copy_from_id": null, - "fk_grp_col_id": null, - "fk_geo_data_col_id": null - }, - { - "title": "My Form View", - "type": 1, - "copy_from_id": null, - "fk_grp_col_id": null, - "fk_geo_data_col_id": null - }, - { - "title": "My Kanban View", - "type": 4, - "copy_from_id": null, - "fk_grp_col_id": "cl_g0a89q9xdry3lu", - "fk_geo_data_col_id": null - }, - { - "title": "My Map View", - "type": 5, - "copy_from_id": null, - "fk_grp_col_id": null, - "fk_geo_data_col_id": "cl_uu1meolj00tlrq" - } - ], - "properties": { - "title": { - "type": "string", - "description": "View Title", - "example": "My View" - }, - "type": { - "type": "number", - "description": "View Type" - }, - "copy_from_id": { - "$ref": "#/components/schemas/StringOrNull", - "description": "ID of view to be copied from. Used in Copy View." - }, - "fk_grp_col_id": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Foreign Key to Grouping Column. Used in creating Kanban View." - }, - "fk_geo_data_col_id": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Foreign Key to Geo Data Column. Used in creating Map View." - } - }, - "required": ["title"] - }, - "ViewUpdateReq": { - "description": "Model for View Update Request", - "x-stoplight": { - "id": "1enlswadfc6p5" - }, - "examples": [ - { - "title": "Grid View 1", - "uuid": "e2457bbf-e29c-4fec-866e-fe3b01dba57f", - "password": "password123", - "lock_type": "collaborative", - "meta": "{\"allowCSVDownload\":true}", - "order": 1, - "show_system_fields": 0 - } - ], - "title": "View Update Request Model", - "type": "object", - "properties": { - "title": { - "maxLength": 255, - "type": "string", - "description": "View Title", - "example": "Grid View 1" - }, - "uuid": { - "maxLength": 255, - "type": "string", - "x-stoplight": { - "id": "vlhs7xs644u8l" - }, - "description": "View UUID. Used in Shared View.", - "example": "e2457bbf-e29c-4fec-866e-fe3b01dba57f" - }, - "password": { - "maxLength": 255, - "type": "string", - "x-stoplight": { - "id": "vlhs7xs644u8l" - }, - "description": "View Password. Used in Shared View.", - "example": "password123" - }, - "lock_type": { - "enum": ["collaborative", "locked", "personal"], - "type": "string", - "description": "Lock type of View.", - "example": "collaborative" - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "description": "Meta info used in View." - }, - "order": { - "type": "number", - "description": "The order of the list of views.", - "example": 1, - "minimum": 0 - }, - "show_system_fields": { - "$ref": "#/components/schemas/Bool", - "description": "Should this view show system fields?" - } - } - }, - "ViewColumnUpdateReq": { - "description": "Model for View Column Update Request", - "x-stoplight": { - "id": "ifzuv29axterb" - }, - "examples": [ - { - "show": 0, - "order": 1 - } - ], - "title": "View Column Update Request Model", - "type": "object", - "properties": { - "show": { - "$ref": "#/components/schemas/Bool", - "description": "View Title", - "x-stoplight": { - "id": "coxius73ejq5x" - } - }, - "order": { - "type": "number", - "description": "The order of the list of views.", - "example": 1, - "minimum": 0 - } - } - }, - "ViewColumnReq": { - "description": "Model for View Column Request", - "x-stoplight": { - "id": "z4bq84nyqkhd8" - }, - "examples": [ - { - "fk_column_id": "cl_5jestblzneb649", - "show": 0, - "order": 1 - } - ], - "title": "View Column Request Model", - "type": "object", - "properties": { - "fk_column_id": { - "$ref": "#/components/schemas/Id", - "x-stoplight": { - "id": "rxd07wvp9hf6s" - }, - "description": "Foreign Key to Column" - }, - "show": { - "$ref": "#/components/schemas/Bool", - "description": "View Title", - "x-stoplight": { - "id": "coxius73ejq5x" - } - }, - "order": { - "type": "number", - "description": "The order of the list of views.", - "example": 1, - "minimum": 0 - } - } - }, - "VisibilityRuleReq": { - "description": "Model for Visibility Rule Request", - "examples": [ - [ - { - "disabled": { - "commenter": true, - "creator": true, - "editor": true, - "guest": true, - "owner": true, - "viewer": true - } - } - ] - ], - "items": { - "properties": { - "id": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "disabled": { - "properties": { - "commenter": { - "$ref": "#/components/schemas/Bool" - }, - "creator": { - "$ref": "#/components/schemas/Bool" - }, - "editor": { - "$ref": "#/components/schemas/Bool" - }, - "guest": { - "$ref": "#/components/schemas/Bool" - }, - "owner": { - "$ref": "#/components/schemas/Bool" - }, - "viewer": { - "$ref": "#/components/schemas/Bool" - } - }, - "type": "object" - } - }, - "type": "object" - }, - "title": "Visibility Rule Request Model", - "type": "array", - "x-stoplight": { - "id": "vuo5q4vwtarx8" - } - } - }, - "responses": { - "ProjectList": { - "description": "Example response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProjectList" - }, - "examples": { - "example-1": { - "value": { - "list": [ - { - "bases": [ - { - "alias": "string", - "config": null, - "created_at": "2023-03-01 14:27:36", - "enabled": true, - "id": "string", - "inflection_column": "camelize", - "inflection_table": "camelize", - "is_meta": true, - "order": 1, - "project_id": "string", - "type": "mysql2", - "updated_at": "2023-03-01 14:27:36" - } - ], - "color": "#24716E", - "created_at": "2023-03-01 14:27:36", - "deleted": true, - "description": "This is my project description", - "id": "p_124hhlkbeasewh", - "is_meta": true, - "meta": {}, - "order": 0, - "prefix": "nc_vm5q__", - "status": "string", - "title": "my-project", - "updated_at": "2023-03-01 14:27:36" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "BaseList": { - "description": "Example response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BaseList" - }, - "examples": { - "example-1": { - "value": { - "list": [ - { - "id": "ds_krsappzu9f8vmo", - "project_id": "p_01clqvzik3izk6", - "alias": null, - "config": "", - "meta": null, - "is_meta": 1, - "type": "mysql2", - "inflection_column": "camelize", - "inflection_table": "camelize", - "created_at": "2023-03-01 16:31:49", - "updated_at": "2023-03-02 11:28:17", - "enabled": 1, - "order": 1 - }, - { - "id": "ds_btbdt19zde0gj9", - "project_id": "p_01clqvzik3izk6", - "alias": "sakila", - "config": "", - "meta": null, - "is_meta": null, - "type": "mysql2", - "inflection_column": "camelize", - "inflection_table": "camelize", - "created_at": "2023-03-02 11:28:17", - "updated_at": "2023-03-02 11:28:17", - "enabled": 1, - "order": 2 - } - ], - "pageInfo": { - "totalRows": 2, - "page": 1, - "pageSize": 2, - "isFirstPage": true, - "isLastPage": true - } - } - } - } - } - } - }, - "TableList": { - "description": "Example response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TableList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "id": "md_5hua2iqloqirhd", - "base_id": "ds_jxuewivwbxeum2", - "project_id": "p_tbhl1hnycvhe5l", - "table_name": "nc_b84e___Sheet-1", - "title": "Sheet-1", - "type": "table", - "meta": null, - "schema": null, - "enabled": true, - "mm": false, - "tags": null, - "pinned": null, - "deleted": null, - "order": 1, - "created_at": "2023-03-11T09:11:45.907Z", - "updated_at": "2023-03-11T09:11:45.907Z" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "ColumnList": { - "description": "Example response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ColumnList" - } - } - } - }, - "FilterList": { - "description": "Example response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FilterList" - } - } - } - }, - "SortList": { - "description": "Example response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SortList" - }, - "examples": {} - } - } - }, - "ViewList": { - "description": "Example response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ViewList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "alias": "string", - "column": [ - { - "alias": "string", - "auto_increment": true, - "auto_update_timestamp": true, - "base_id": "string", - "character_maximum_length": "string", - "character_set_name": "string", - "colOptions": { - "deleted": "string", - "dr": "string", - "fk_child_column_id": "string", - "fk_column_id": "string", - "fk_index_name": "string", - "fk_mm_child_column_id": "string", - "fk_mm_model_id": "string", - "fk_mm_parent_column_id": "string", - "fk_parent_column_id": "string", - "id": "string", - "order": "string", - "type": "string", - "ur": "string", - "virtual": true - }, - "column_comment": "string", - "column_default": "string", - "column_ordinal_position": "string", - "column_type": "string", - "data_type": "string", - "data_type_x": "string", - "data_type_x_precision": "string", - "data_type_x_scale": "string", - "deleted": true, - "fk_model_id": "string", - "id": "string", - "numeric_precision": "string", - "numeric_scale": "string", - "order": 0, - "primary_key": true, - "primary_value": true, - "rqd": "string", - "title": "string", - "ui_data_type": "string", - "un": "string", - "unique": true, - "visible": true - } - ], - "columnByIds": {}, - "deleted": true, - "enabled": true, - "fk_base_id": "string", - "fk_project_id": "string", - "id": "string", - "order": 0, - "parent_id": "string", - "pinned": true, - "show_as": "string", - "tags": "string", - "title": "string", - "type": "string" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "SharedViewList": { - "description": "Example response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SharedViewList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:46:31", - "fk_model_id": "md_mhs9z4r2ak98x0", - "id": "vw_lg052cnc1c26kf", - "is_default": 1, - "lock_type": "collaborative", - "meta": {}, - "order": 1, - "password": null, - "project_id": "p_xm3thidrblw4n7", - "show": 1, - "show_system_fields": null, - "title": "Sheet-1", - "type": 3, - "updated_at": "2023-03-02 17:46:31", - "uuid": null, - "view": { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:46:31", - "fk_view_id": "vw_lg052cnc1c26kf", - "meta": null, - "project_id": "p_xm3thidrblw4n7", - "row_height": null, - "updated_at": "2023-03-02 17:46:31", - "uuid": null - } - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "HookList": { - "description": "Example response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HookList" - } - } - } - }, - "UserList": { - "description": "Example response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UserList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "email": "user@example.com", - "email_verified": true, - "firstname": "Alice", - "id": "us_8kugj628ebjngs", - "lastname": "Smith", - "roles": "org-level-viewer" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "APITokenList": { - "description": "Example response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiTokenList" - }, - "examples": {} - } - }, - "type": "object", - "properties": { - "list": { - "type": "array", - "x-stoplight": { - "id": "uukp6v55zfp7i" - }, - "items": { - "$ref": "#/components/schemas/ApiToken", - "x-stoplight": { - "id": "9zqpoqfkdxy0y" - } - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated", - "x-stoplight": { - "id": "6unr17jyisial" - } - } - } - }, - "BadRequest": { - "description": "BadReqeust", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "p9mk4oi0hbihm" - }, - "example": "BadRequest [Error]: " - } - }, - "required": ["msg"] - }, - "examples": { - "Example 1": { - "value": { - "msg": "BadRequest [Error]: " - } - } - } - } - }, - "headers": {} - } - }, - "securitySchemes": { - "xc-auth": { - "name": "Auth Token ", - "type": "apiKey", - "in": "header", - "description": "Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable `NC_JWT_EXPIRES_IN`." - }, - "xc-shared-base-id": { - "name": "Shared Base ID", - "type": "apiKey", - "in": "header", - "description": "Shared base uuid" - } - }, - "parameters": { - "xc-auth": { - "name": "xc-auth", - "in": "header", - "required": false, - "schema": { - "type": "string" - }, - "description": "Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN." - } - } - } -}{ - "openapi": "3.1.0", - "info": { - "title": "nocodb", - "version": "1.0", - "description": "NocoDB API Documentation" - }, - "x-tagGroups": [ - { - "name": "Auth APIs", - "tags": ["Auth", "API Token"] - }, - { - "name": "Public APIs", - "tags": ["Public"] - }, - { - "name": "Data APIs", - "tags": ["DB Table Row", "DB View Row", "Storage"] - }, - { - "name": "Meta APIs", - "tags": [ - "Base", - "DB Table", - "DB Table Column", - "DB Table Filter", - "DB Table Sort", - "DB Table Webhook", - "DB Table Webhook Filter", - "DB View", - "DB View Column", - "DB View Share", - "Plugin", - "Project", - "Utils" - ] - }, - { - "name": "Organisation APIs", - "tags": ["Org App Settings", "Org License", "Org Tokens", "Org Users"] - } - ], - "servers": [ - { - "url": "http://localhost:8080" - } - ], - "paths": { - "/api/v1/auth/user/signup": { - "post": { - "summary": "Signup", - "operationId": "auth-signup", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "token": { - "type": "string", - "description": "The signed JWT token for information exchange", - "example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbWFpbCI6IndAbm9jb2RiLmNvbSIsImZpcnN0bmFtZSI6bnVsbCwibGFzdG5hbWUiOm51bGwsImlkIjoidXNfYjN4bzJpNDRueDV5OWwiLCJyb2xlcyI6Im9yZy1sZXZlbC1jcmVhdG9yLHN1cGVyIiwidG9rZW5fdmVyc2lvbiI6ImJmMTc3ZGUzYjk3YjAzMjY4YjU0NGZmMjMzNGU5YjFhMGUzYzgxM2NiYzliOTJkYWMwYmM5NTRiNmUzN2ZjMTJjYmFkNDM2NmIwYzExZTdjIiwiaWF0IjoxNjc4MDc4NDMyLCJleHAiOjE2NzgxMTQ0MzJ9.gzwp_svZlbA5PV_eawYV-9UFjZVjniy-tCDce16xrkI" - } - } - }, - "examples": { - "Example 1": { - "value": { - "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbWFpbCI6IndAbm9jb2RiLmNvbSIsImZpcnN0bmFtZSI6bnVsbCwibGFzdG5hbWUiOm51bGwsImlkIjoidXNfYjN4bzJpNDRueDV5OWwiLCJyb2xlcyI6Im9yZy1sZXZlbC1jcmVhdG9yLHN1cGVyIiwidG9rZW5fdmVyc2lvbiI6ImJmMTc3ZGUzYjk3YjAzMjY4YjU0NGZmMjMzNGU5YjFhMGUzYzgxM2NiYzliOTJkYWMwYmM5NTRiNmUzN2ZjMTJjYmFkNDM2NmIwYzExZTdjIiwiaWF0IjoxNjc4MDc4NDMyLCJleHAiOjE2NzgxMTQ0MzJ9.gzwp_svZlbA5PV_eawYV-9UFjZVjniy-tCDce16xrkI" - } - } - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string" - } - } - }, - "examples": { - "Invalid email": { - "value": { - "msg": "Invalid email" - } - }, - "Invalid invite url": { - "value": { - "msg": "Invalid invite url" - } - }, - "Expired invite url": { - "value": { - "msg": "Expired invite url, Please contact super admin to get a new invite url" - } - }, - "User already exist": { - "value": { - "msg": "User already exist" - } - }, - "Invite only signup": { - "value": { - "msg": "Not allowed to signup, contact super admin" - } - } - } - } - } - } - }, - "tags": ["Auth"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SignUpReq" - }, - "examples": { - "Example 1": { - "value": { - "email": "user@example.com", - "password": "password123456789", - "firstname": "Alice", - "lastname": "Smith", - "token": null, - "ignore_subscribe": 0 - } - } - } - } - } - }, - "description": "Create a new user with provided email and password and first user is marked as super admin. " - } - }, - "/api/v1/auth/user/signout": { - "post": { - "summary": "Signout", - "operationId": "auth-signout", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "description": "Success Message", - "example": "Signed out successfully" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "Signed out successfully" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Auth"], - "description": "Clear refresh token from the database and cookie." - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "/api/v1/auth/user/signin": { - "post": { - "summary": "Signin", - "operationId": "auth-signin", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "token": { - "type": "string", - "description": "The signed JWT token for information exchange", - "example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbWFpbCI6IndAbm9jb2RiLmNvbSIsImZpcnN0bmFtZSI6bnVsbCwibGFzdG5hbWUiOm51bGwsImlkIjoidXNfYjN4bzJpNDRueDV5OWwiLCJyb2xlcyI6Im9yZy1sZXZlbC1jcmVhdG9yLHN1cGVyIiwidG9rZW5fdmVyc2lvbiI6ImJmMTc3ZGUzYjk3YjAzMjY4YjU0NGZmMjMzNGU5YjFhMGUzYzgxM2NiYzliOTJkYWMwYmM5NTRiNmUzN2ZjMTJjYmFkNDM2NmIwYzExZTdjIiwiaWF0IjoxNjc4MDc4NDMyLCJleHAiOjE2NzgxMTQ0MzJ9.gzwp_svZlbA5PV_eawYV-9UFjZVjniy-tCDce16xrkI" - } - } - }, - "examples": { - "Example 1": { - "value": { - "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbWFpbCI6IndAbm9jb2RiLmNvbSIsImZpcnN0bmFtZSI6bnVsbCwibGFzdG5hbWUiOm51bGwsImlkIjoidXNfYjN4bzJpNDRueDV5OWwiLCJyb2xlcyI6Im9yZy1sZXZlbC1jcmVhdG9yLHN1cGVyIiwidG9rZW5fdmVyc2lvbiI6ImJmMTc3ZGUzYjk3YjAzMjY4YjU0NGZmMjMzNGU5YjFhMGUzYzgxM2NiYzliOTJkYWMwYmM5NTRiNmUzN2ZjMTJjYmFkNDM2NmIwYzExZTdjIiwiaWF0IjoxNjc4MDc4NDMyLCJleHAiOjE2NzgxMTQ0MzJ9.gzwp_svZlbA5PV_eawYV-9UFjZVjniy-tCDce16xrkI" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Auth"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SignInReq" - }, - "examples": { - "example-1": { - "value": { - "email": "user@example.com", - "password": "Password" - } - } - } - } - } - }, - "description": "Authenticate existing user with their email and password. Successful login will return a JWT access-token. " - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "/api/v1/auth/user/me": { - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "get": { - "summary": "Get User Info", - "operationId": "auth-me", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UserInfo" - }, - "examples": { - "example-1": { - "value": { - "id": "us_8kugj628ebjngs", - "email": "user@example.com", - "email_verified": true, - "firstname": "Alice", - "lastname": "Smith", - "roles": "org-level-viewer" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Auth"], - "description": "Returns authenticated user info", - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id" - }, - "in": "query", - "name": "project_id", - "description": "Pass project id to get project specific roles along with user info" - } - ] - } - }, - "/api/v1/auth/password/forgot": { - "post": { - "summary": "Forget Password", - "operationId": "auth-password-forgot", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "q9s5vh2i34x6c" - }, - "example": "Please check your email to reset the password", - "description": "Success Message" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "Please check your email to reset the password" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Emails user with a reset url.", - "tags": ["Auth"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PasswordForgotReq" - }, - "examples": { - "Example 1": { - "value": { - "email": "user@example.com" - } - } - } - } - }, - "description": "Pass registered user email id in request body" - } - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "/api/v1/auth/password/change": { - "post": { - "summary": "Change Password", - "operationId": "auth-password-change", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "description": "Success Message" - } - } - }, - "examples": { - "Success response": { - "value": { - "msg": "Password has been updated successfully" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Change password of authenticated user with a new one.", - "tags": ["Auth"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PasswordChangeReq" - }, - "examples": { - "example-1": { - "value": { - "currentPassword": "currentPassword", - "newPassword": "newPassword" - } - } - } - } - }, - "description": "Old password need to be passed along with new password for changing password." - } - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "/api/v1/auth/token/validate/{token}": { - "post": { - "summary": "Verify Reset Token", - "operationId": "auth-password-reset-token-validate", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "unxdsok22kg1y" - }, - "example": "Token has been validated successfully", - "description": "Success Message" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "Token has been validated successfully" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Validate password reset url token.", - "tags": ["Auth"], - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "parameters": [ - { - "schema": { - "type": "string", - "format": "uuid", - "example": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11" - }, - "name": "token", - "in": "path", - "required": true, - "description": "Reset Token" - } - ] - }, - "/api/v1/auth/email/validate/{token}": { - "post": { - "summary": "Verify Email", - "operationId": "auth-email-validate", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "u49sbr20s9rgf" - }, - "description": "Success Message", - "example": "Email has been verified successfully" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "Email has been verified successfully" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Api for verifying email where token need to be passed which is shared to user email.", - "tags": ["Auth"], - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "parameters": [ - { - "schema": { - "type": "string", - "format": "uuid", - "example": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11" - }, - "name": "token", - "in": "path", - "required": true, - "description": "Validation Token" - } - ] - }, - "/api/v1/auth/password/reset/{token}": { - "post": { - "summary": "Reset Password", - "operationId": "auth-password-reset", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "2to6ro4121rfx" - }, - "description": "Success Message", - "example": "Password has been reset successfully" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "Password has been reset successfully" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Update user password to new by using reset token.", - "tags": ["Auth"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PasswordResetReq" - }, - "examples": { - "Example 1": { - "value": { - "password": "newpassword" - } - } - } - } - } - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "parameters": [ - { - "schema": { - "type": "string", - "format": "uuid", - "example": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11" - }, - "name": "token", - "in": "path", - "required": true, - "description": "Reset Password Token" - } - ] - }, - "/api/v1/auth/token/refresh": { - "post": { - "summary": "Refresh Token", - "operationId": "auth-token-refresh", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "token": { - "type": "string", - "description": "New access token for user", - "example": "96751db2d53fb834382b682268874a2ea9ee610e4d904e688d1513f11d3c30d62d36d9e05dec0d63" - } - } - }, - "examples": { - "Example 1": { - "value": { - "token": "96751db2d53fb834382b682268874a2ea9ee610e4d904e688d1513f11d3c30d62d36d9e05dec0d63" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Regenerate user refresh token", - "tags": ["Auth"], - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "/api/v1/tokens": { - "get": { - "summary": "List Organisation API Tokens", - "operationId": "org-tokens-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiTokenList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "id": "1", - "fk_user_id": "us_b3xo2i44nx5y9l", - "description": "This API Token is for ABC application", - "token": "DYh540o8hbWpUGdarekECKLdN5OhlgCUWutVJYX2" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "List all organisation API tokens. Access with API tokens will be blocked.", - "tags": ["Org Tokens"], - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "post": { - "summary": "Create Organisation API Token", - "operationId": "org-tokens-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiToken" - }, - "examples": { - "Example 1": { - "value": { - "id": "1", - "fk_user_id": "us_b3xo2i44nx5y9l", - "description": "This API Token is for ABC application", - "token": "DYh540o8hbWpUGdarekECKLdN5OhlgCUWutVJYX2" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiTokenReq" - }, - "examples": { - "Example 1": { - "value": { - "description": "This API token is for ABC application" - } - } - } - } - } - }, - "tags": ["Org Tokens"], - "description": "Creat an organisation API token. Access with API tokens will be blocked." - } - }, - "/api/v1/tokens/{token}": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "token", - "in": "path", - "required": true, - "description": "API Token" - } - ], - "delete": { - "summary": "Delete Organisation API Tokens", - "operationId": "org-tokens-delete", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number", - "example": 1 - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Org Tokens"], - "description": "Delete an organisation API token. Access with API tokens will be blocked.", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/license": { - "get": { - "summary": "Get App License", - "operationId": "org-license-get", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Application license key" - } - } - }, - "examples": { - "Example 1": { - "value": { - "key": "195f7bcc-c3e1-43c5-b23c-8d8127280e7d" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Get the application license key. Exclusive for super admin.", - "tags": ["Org License"], - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "post": { - "summary": "Create App License", - "operationId": "org-license-set", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "wsiywigeb9hjl" - }, - "example": "The license key has been saved" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "The license key has been saved" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/LicenseReq" - }, - "examples": { - "Example 1": { - "value": { - "key": "1234567890" - } - } - } - } - } - }, - "tags": ["Org License"], - "description": "Set the application license key. Exclusive for super admin.", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/app-settings": { - "get": { - "summary": "Get App Settings", - "operationId": "org-app-settings-get", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "invite_only_signup": { - "type": "boolean", - "description": "Status of invite only signup", - "example": true - } - } - }, - "examples": { - "Example 1": { - "value": { - "invite_only_signup": true - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Get the application settings. Exclusive for super admin.", - "tags": ["Org App Settings"], - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "post": { - "summary": "Create App Settings", - "operationId": "org-app-settings-set", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "6qbh8ijtc4tva" - }, - "example": "The app settings have been saved" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "The app settings have been saved" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "invite_only_signup": { - "type": "boolean", - "description": "Status of invite only signup", - "example": true - } - } - }, - "examples": { - "Example 1": { - "value": { - "invite_only_signup": true - } - } - } - } - } - }, - "tags": ["Org App Settings"], - "description": "Update the application settings. Exclusive for super admin.", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/users": { - "get": { - "summary": "List Organisation Users", - "operationId": "org-users-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UserList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "email": "user@example.com", - "email_verified": true, - "firstname": "Alice", - "id": "us_8kugj628ebjngs", - "lastname": "Smith", - "roles": "org-level-viewer" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "List all organisation users. Exclusive for Super Admin. Access with API Tokens will be blocked.", - "tags": ["Org Users"], - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "post": { - "summary": "Create Organisation User", - "operationId": "org-users-add", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "x-examples": { - "Example 1": { - "invite_token": "c22c129f-d947-4030-a838-1b498fce21bb", - "email": "w123@nocodb.com" - } - }, - "properties": { - "invite_token": { - "type": "string", - "description": "Invite Token" - }, - "email": { - "type": "string", - "description": "User email", - "example": "user@example.com" - } - } - }, - "examples": { - "Example 1": { - "value": { - "invite_token": "c22c129f-d947-4030-a838-1b498fce21bb", - "email": "user@example.com" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/OrgUserReq" - }, - "examples": { - "Example 1": { - "value": { - "email": "user@example.com", - "roles": "org-level-creator" - } - } - } - } - } - }, - "tags": ["Org Users"], - "description": "Create an organisation user. Exclusive for Super Admin. Access with API Tokens will be blocked.", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/users/{userId}": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "us_b3xo2i44nx5y9l" - }, - "name": "userId", - "in": "path", - "required": true, - "description": "Unique User ID" - } - ], - "patch": { - "summary": "Update Organisation User", - "operationId": "org-users-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "6oa45bkw7j57j" - }, - "example": "The user has been updated successfully" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "The user has been updated successfully" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Org Users"], - "description": "Update an organisation user by User ID. Exclusive for Super Admin. Access with API Tokens will be blocked.", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/OrgUserReq" - }, - "examples": { - "Example 1": { - "value": { - "email": "user@example.com", - "roles": "org-level-creator" - } - } - } - } - }, - "description": "" - } - }, - "delete": { - "summary": "Delete Organisation User", - "operationId": "org-users-delete", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "buvrqjvv255tf" - }, - "example": "The user has been deleted successfully", - "description": "Sucess Message" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "The user has been deleted successfully" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Org Users"], - "description": "Delete an organisation user by User ID. Exclusive for Super Admin. Access with API Tokens will be blocked." - } - }, - "/api/v1/users/{userId}/resend-invite": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "us_b3xo2i44nx5y9l" - }, - "name": "userId", - "in": "path", - "required": true, - "description": "Unique User ID" - } - ], - "post": { - "summary": "Invite Organisation User", - "operationId": "org-users-resend-invite", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "aixfqd9jfh5pq" - }, - "example": "The invitation has been sent to the target user", - "description": "Success Message" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "The invitation has been sent to the target user" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Org Users"], - "description": "Resend Invitation to a specific user. Exclusive for Super Admin. Access with API Tokens will be blocked.", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/users/{userId}/generate-reset-url": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "us_b3xo2i44nx5y9l" - }, - "name": "userId", - "in": "path", - "required": true, - "description": "Unique User ID" - } - ], - "post": { - "summary": "Generate Organisation User Password Reset Token", - "operationId": "org-users-generate-password-reset-token", - "tags": ["Org Users"], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "reset_password_token": { - "type": "string", - "description": "Password Reset Token for the user" - }, - "reset_password_url": { - "type": "string", - "description": "Password Reset URL for the user" - } - } - }, - "examples": { - "Example 1": { - "value": { - "reset_password_token": "string", - "reset_password_url": "string" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Generate Password Reset Token for Organisation User. Exclusive for Super Admin. Access with API Tokens will be blocked.", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/projects/{projectId}/users": { - "get": { - "summary": "List Project Users", - "operationId": "auth-project-user-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "users": { - "type": "object", - "properties": { - "list": { - "type": "array", - "uniqueItems": true, - "minItems": 1, - "items": { - "$ref": "#/components/schemas/User" - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated" - } - }, - "required": ["list", "pageInfo"] - } - } - }, - "examples": { - "Example 1": { - "value": { - "users": { - "list": [ - { - "email": "user@example.com", - "email_verified": true, - "firstname": "Alice", - "id": "us_8kugj628ebjngs", - "lastname": "Smith", - "roles": "org-level-viewer" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "List all users in the given project.", - "tags": ["Auth"], - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - } - ], - "post": { - "summary": "Create Project User", - "operationId": "auth-project-user-add", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "waau9tvy75zsd" - }, - "description": "Success Message for inviting single email", - "example": "The user has been invited successfully" - }, - "invite_token": { - "type": "string", - "x-stoplight": { - "id": "yx0s35u8ds3p7" - }, - "example": "8354ddba-a769-4d64-8397-eccb2e2b3c06" - }, - "error": { - "type": "array", - "x-stoplight": { - "id": "yhfi6wzhr6zr1" - }, - "items": { - "x-stoplight": { - "id": "ce0hlv3d0f96j" - }, - "type": "object", - "properties": { - "email": { - "type": "string", - "x-stoplight": { - "id": "dgnh01j4lxvl1" - }, - "example": "w@nocodb.com" - }, - "error": { - "type": "string", - "x-stoplight": { - "id": "7dgttqiijg8no" - }, - "example": "" - } - } - } - }, - "email": { - "type": "string", - "x-stoplight": { - "id": "08pqst2q30vot" - }, - "example": "w@nocodb.com" - } - } - }, - "examples": { - "Inviting a user without any errors": { - "value": { - "msg": "The user has been invited successfully" - } - }, - "Inviting a user but invitation email failed to send": { - "value": { - "invite_token": "8354ddba-a769-4d64-8397-eccb2e2b3c06", - "email": "w@nocodb.com" - } - }, - "Inviting multiple users": { - "value": { - "invite_token": "8354ddba-a769-4d64-8397-eccb2e2b3c06", - "error": [ - { - "email": "w@nocodb.com", - "error": "" - } - ] - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProjectUserReq" - }, - "examples": { - "Example 1": { - "value": { - "email": "user@example.com", - "roles": "owner" - } - } - } - } - } - }, - "tags": ["Auth"], - "description": "Create a user and add it to the given project", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/projects/{projectId}/info": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - } - ], - "get": { - "summary": "Get Project info", - "operationId": "project-meta-get", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "Node": { - "type": "string", - "description": "Node version", - "example": "v12.16.1" - }, - "Arch": { - "type": "string", - "description": "Architecture type", - "example": "x64" - }, - "Platform": { - "type": "string", - "description": "Platform type", - "example": "linux" - }, - "Docker": { - "type": "boolean", - "description": "Is docker", - "example": false - }, - "Database": { - "type": "string", - "description": "Database type", - "example": "postgres" - }, - "ProjectOnRootDB": { - "type": "boolean", - "description": "Is project on rootdb", - "example": false - }, - "RootDB": { - "type": "string", - "description": "Root database type", - "example": "postgres" - }, - "PackageVersion": { - "type": "string", - "description": "Package version", - "example": "1.0.0" - } - } - }, - "examples": { - "Example 1": { - "value": { - "Node": "v12.16.1", - "Arch": "x64", - "Platform": "linux", - "Docker": false, - "Database": "postgres", - "ProjectOnRootDB": false, - "RootDB": "postgres", - "PackageVersion": "1.0.0" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Project"], - "description": "Get info such as node version, arch, platform, is docker, rootdb and package version of a given project", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/projects/{projectId}/users/{userId}": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - }, - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "us_b3xo2i44nx5y9l" - }, - "name": "userId", - "in": "path", - "required": true, - "description": "Unique User ID" - } - ], - "patch": { - "summary": "Update Project User", - "operationId": "auth-project-user-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "5a2q8as60daly" - }, - "description": "Success Message", - "example": "The user has been updated successfully" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "The user has been updated successfully" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProjectUserReq" - }, - "examples": { - "Example 1": { - "value": { - "email": "user@example.com", - "roles": "owner" - } - } - } - } - } - }, - "tags": ["Auth"], - "description": "Update a given user in a given project. Exclusive for Super Admin. Access with API Tokens will be blocked.", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "delete": { - "summary": "Delete Project User", - "operationId": "auth-project-user-remove", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "5h7c9lqh5ynve" - }, - "example": "The user has been updated successfully", - "description": "Success Message" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "The user has been updated successfully" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Auth"], - "description": "Delete a given user in a given project. Exclusive for Super Admin. Access with API Tokens will be blocked.", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/projects/{projectId}/visibility-rules": { - "get": { - "summary": "Get UI ACL", - "operationId": "project-model-visibility-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": {} - }, - "examples": { - "Example 1": { - "value": [ - { - "ptn": "nc_09gt___Sheet-1", - "_ptn": "Sheet-1", - "ptype": "table", - "tn": "Sheet-1", - "_tn": "Sheet-1", - "table_meta": null, - "id": "vw_75neroyqdye94k", - "base_id": "ds_eol59jg2l4zwev", - "project_id": "p_63b4q0qengen1x", - "fk_model_id": "md_5mipbdg6ketmv8", - "title": "Sheet-1", - "type": 3, - "is_default": true, - "show_system_fields": null, - "lock_type": "collaborative", - "uuid": "24a6d0bb-e45d-4b1a-bfef-f492d870de9f", - "password": null, - "show": true, - "order": 1, - "created_at": "2023-03-08T10:44:55.253Z", - "updated_at": "2023-03-10T07:18:44.908Z", - "meta": { - "allowCSVDownload": true - }, - "view": { - "fk_view_id": "vw_75neroyqdye94k", - "base_id": "ds_eol59jg2l4zwev", - "project_id": "p_63b4q0qengen1x", - "uuid": null, - "created_at": "2023-03-08T10:44:55.288Z", - "updated_at": "2023-03-08T10:44:55.288Z", - "meta": null, - "row_height": null - }, - "disabled": { - "owner": false, - "creator": false, - "viewer": false, - "editor": false, - "commenter": false, - "guest": false - } - } - ] - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Hide / show views based on user role", - "tags": ["Project"], - "parameters": [ - { - "schema": { - "type": "boolean" - }, - "in": "query", - "name": "includeM2M" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - } - ], - "post": { - "summary": "Create UI ACL", - "operationId": "project-model-visibility-set", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "2txh071wsodys" - }, - "example": "UI ACL has been created successfully" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "UI ACL has been created successfully" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VisibilityRuleReq" - } - } - } - }, - "tags": ["Project"], - "description": "Hide / show views based on user role", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/projects/": { - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "get": { - "summary": "List Projects", - "operationId": "project-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProjectList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "bases": [ - { - "alias": "string", - "config": null, - "created_at": "2023-03-01 14:27:36", - "enabled": true, - "id": "string", - "inflection_column": "camelize", - "inflection_table": "camelize", - "is_meta": true, - "order": 1, - "project_id": "string", - "type": "mysql2", - "updated_at": "2023-03-01 14:27:36" - } - ], - "color": "#24716E", - "created_at": "2023-03-01 14:27:36", - "deleted": true, - "description": "This is my project description", - "id": "p_124hhlkbeasewh", - "is_meta": true, - "meta": {}, - "order": 0, - "prefix": "nc_vm5q__", - "status": "string", - "title": "my-project", - "updated_at": "2023-03-01 14:27:36" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "List all project meta data", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["Project"] - }, - "post": { - "summary": "Create Project", - "operationId": "project-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProjectReq" - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/Project" - }, - { - "type": "object", - "properties": { - "external": { - "type": "boolean", - "default": false, - "description": "If true, the project will us an external database else it will use the root database" - } - } - } - ] - }, - "examples": { - "Example 1": { - "value": { - "bases": [ - { - "alias": "string", - "config": null, - "enabled": true, - "id": "string", - "inflection_column": "camelize", - "inflection_table": "camelize", - "is_meta": true, - "order": 1, - "project_id": "string", - "type": "mysql2", - "updated_at": "2023-03-01 14:27:36" - } - ], - "color": "#24716E", - "created_at": "2023-03-01 14:27:36", - "deleted": true, - "description": "This is my project description", - "id": "p_124hhlkbeasewh", - "is_meta": true, - "meta": {}, - "order": 0, - "prefix": "nc_vm5q__", - "status": "string", - "title": "my-project", - "external": false - } - } - } - } - } - }, - "tags": ["Project"], - "description": "Create a new project", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/projects/{projectId}": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - } - ], - "get": { - "summary": "Get Project", - "operationId": "project-read", - "description": "Get the info of a given project", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["Project"], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Project" - }, - "examples": { - "Example 1": { - "value": { - "bases": [ - { - "alias": "string", - "config": null, - "enabled": true, - "id": "string", - "inflection_column": "camelize", - "inflection_table": "camelize", - "is_meta": true, - "order": 1, - "project_id": "string", - "type": "mysql2", - "updated_at": "2023-03-01 14:27:36" - } - ], - "color": "#24716E", - "created_at": "2023-03-01 14:27:36", - "deleted": true, - "description": "This is my project description", - "id": "p_124hhlkbeasewh", - "is_meta": true, - "meta": {}, - "order": 0, - "prefix": "nc_vm5q__", - "status": "string", - "title": "my-project" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - } - }, - "delete": { - "summary": "Delete Project", - "operationId": "project-delete", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "boolean" - }, - "examples": { - "Example 1": { - "value": true - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Project"], - "description": "Delete the given project", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "patch": { - "summary": "Update Project", - "operationId": "project-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number", - "example": 1 - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Project"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProjectUpdateReq" - }, - "examples": { - "Example 1": { - "value": { - "color": "#24716E", - "meta": null, - "title": "My Project" - } - } - } - } - } - }, - "description": "Update the given project", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/projects/{projectId}/bases/{baseId}": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - }, - { - "schema": { - "type": "string", - "pattern": "ds_j04jmxh5xg10lu" - }, - "name": "baseId", - "in": "path", - "required": true, - "description": "Unique Base ID" - } - ], - "get": { - "summary": "Get Base", - "operationId": "base-read", - "description": "Get the base details of a given project", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["Base"], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Base" - }, - "examples": { - "Example 1": { - "value": { - "alias": null, - "config": "", - "enabled": 1, - "id": "ds_krsappzu9f8vmo", - "inflection_column": "camelize", - "inflection_table": "camelize", - "is_meta": 1, - "meta": null, - "order": 1, - "project_id": "p_01clqvzik3izk6", - "type": "mysql2" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - } - }, - "delete": { - "summary": "Delete Base", - "operationId": "base-delete", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "boolean" - }, - "examples": { - "Example 1": { - "value": true - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Base"], - "description": "Delete the base details of a given project", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "patch": { - "summary": "Update Base", - "operationId": "base-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {} - }, - "examples": { - "Example 1": { - "value": { - "id": "ds_rrplkgy0pq1f3c", - "project_id": "p_63b4q0qengen1x", - "alias": "sakila", - "meta": null, - "is_meta": null, - "type": "mysql2", - "inflection_column": "camelize", - "inflection_table": "camelize", - "created_at": "2023-03-11T10:31:15.341Z", - "updated_at": "2023-03-11T10:32:25.763Z", - "enabled": true, - "order": 2 - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Base"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "examples": { - "Example 1": { - "value": { - "alias": "sakila", - "type": "mysql2", - "config": { - "client": "mysql2", - "connection": { - "host": "localhost", - "port": "3306", - "user": "root", - "password": "password", - "database": "sakila" - } - }, - "inflection_column": "camelize", - "inflection_table": "camelize" - } - } - } - } - } - }, - "description": "Update the base details of a given project", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/projects/{projectId}/bases/": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - } - ], - "get": { - "summary": "List Bases", - "operationId": "base-list", - "description": "Get project base list", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["Base"], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BaseList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "alias": null, - "config": "", - "enabled": 1, - "id": "ds_krsappzu9f8vmo", - "inflection_column": "camelize", - "inflection_table": "camelize", - "is_meta": 1, - "meta": null, - "order": 1, - "project_id": "p_01clqvzik3izk6", - "type": "mysql2" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - } - }, - "post": { - "summary": "Create Base", - "operationId": "base-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Base" - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/Base" - }, - { - "type": "object", - "properties": { - "external": { - "type": "boolean", - "default": false - } - } - } - ] - }, - "examples": { - "Example 1": { - "value": { - "alias": null, - "config": "", - "enabled": 1, - "id": "ds_krsappzu9f8vmo", - "inflection_column": "camelize", - "inflection_table": "camelize", - "is_meta": 1, - "meta": null, - "order": 1, - "project_id": "p_01clqvzik3izk6", - "type": "mysql2", - "external": false - } - } - } - } - } - }, - "tags": ["Base"], - "description": "Create a new base on a given project", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/projects/{projectId}/shared": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - } - ], - "get": { - "summary": "Get Project Shared Base", - "operationId": "project-shared-base-get", - "description": "Get Project Shared Base", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["Project"], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "uuid": { - "type": "string", - "format": "uuid", - "example": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11" - }, - "url": { - "type": "string", - "format": "uri" - }, - "roles": { - "type": "string", - "example": "viewer" - } - } - }, - "examples": { - "Example 1": { - "value": { - "uuid": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11", - "url": "http://example.com", - "roles": "viewer" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - } - }, - "delete": { - "summary": "Delete Project Shared Base", - "operationId": "project-shared-base-disable", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "boolean" - }, - "examples": { - "Example 1": { - "value": true - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Project"], - "description": "Delete Project Shared Base", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "post": { - "summary": "Create Project Shared Base", - "operationId": "project-shared-base-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "uuid": { - "$ref": "#/components/schemas/StringOrNull" - }, - "roles": { - "$ref": "#/components/schemas/StringOrNull" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Project"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SharedBaseReq" - }, - "examples": { - "Example 1": { - "value": { - "roles": "editor", - "password": "password123" - } - } - } - } - } - }, - "description": "Create Project Shared Base", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "patch": { - "summary": "Update Project Shared Base", - "operationId": "project-shared-base-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "uuid": { - "type": "string", - "format": "uuid", - "example": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11" - }, - "url": { - "type": "string", - "format": "uri" - }, - "roles": { - "type": "string", - "example": "viewer" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SharedBaseReq" - }, - "examples": { - "Example 1": { - "value": { - "password": "password123", - "roles": "editor" - } - } - } - } - } - }, - "tags": ["Project"], - "description": "Update Project Shared Base", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/projects/{projectId}/cost": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - } - ], - "get": { - "summary": "Project Cost", - "operationId": "project-cost", - "description": "Calculate the Project Cost", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["Project"], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {} - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "x-internal": true - } - }, - "/api/v1/db/meta/projects/{projectId}/tables": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - } - ], - "post": { - "summary": "Create Table", - "operationId": "db-table-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Table" - }, - "examples": { - "Example 1": { - "value": { - "base_id": "ds_g4ccx6e77h1dmi", - "columns": [ - { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": "CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP", - "clen": null, - "column_name": "updated_at", - "cop": "4", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "timestamp", - "deleted": null, - "dt": "timestamp", - "dtx": "specificType", - "dtxp": "0", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_m4wkaqgqqjzoeh", - "meta": null, - "np": null, - "ns": null, - "order": 4, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 0, - "system": 0, - "title": "UpdatedAt", - "uidt": "DateTime", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": "CURRENT_TIMESTAMP", - "clen": null, - "column_name": "created_at", - "cop": "3", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "timestamp", - "deleted": null, - "dt": "timestamp", - "dtx": "specificType", - "dtxp": "0", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_jpl0qu4gj4rexq", - "meta": null, - "np": null, - "ns": null, - "order": 3, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 0, - "system": 0, - "title": "CreatedAt", - "uidt": "DateTime", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": null, - "clen": "45", - "column_name": "title", - "cop": "2", - "created_at": "2023-03-02 17:04:06", - "csn": "utf8mb4", - "ct": "varchar(45)", - "deleted": null, - "dt": "varchar", - "dtx": "specificType", - "dtxp": "45", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_c5knoi4xs4sfpt", - "meta": null, - "np": null, - "ns": null, - "order": 2, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": 1, - "rqd": 0, - "system": 0, - "title": "Title", - "uidt": "SingleLineText", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - { - "ai": 1, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": null, - "clen": null, - "column_name": "id", - "cop": "1", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "int unsigned", - "deleted": null, - "dt": "int", - "dtx": "specificType", - "dtxp": "", - "dtxs": "0", - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_phvuuwjrzcdo0g", - "meta": null, - "np": "10", - "ns": "0", - "order": 1, - "pk": 1, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 1, - "system": 0, - "title": "Id", - "uidt": "ID", - "un": 1, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - } - ], - "columnsById": { - "cl_c5knoi4xs4sfpt": { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": null, - "clen": "45", - "column_name": "title", - "cop": "2", - "created_at": "2023-03-02 17:04:06", - "csn": "utf8mb4", - "ct": "varchar(45)", - "deleted": null, - "dt": "varchar", - "dtx": "specificType", - "dtxp": "45", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_c5knoi4xs4sfpt", - "meta": null, - "np": null, - "ns": null, - "order": 2, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": 1, - "rqd": 0, - "system": 0, - "title": "Title", - "uidt": "SingleLineText", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - "cl_jpl0qu4gj4rexq": { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": "CURRENT_TIMESTAMP", - "clen": null, - "column_name": "created_at", - "cop": "3", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "timestamp", - "deleted": null, - "dt": "timestamp", - "dtx": "specificType", - "dtxp": "0", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_jpl0qu4gj4rexq", - "meta": null, - "np": null, - "ns": null, - "order": 3, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 0, - "system": 0, - "title": "CreatedAt", - "uidt": "DateTime", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - "cl_m4wkaqgqqjzoeh": { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": "CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP", - "clen": null, - "column_name": "updated_at", - "cop": "4", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "timestamp", - "deleted": null, - "dt": "timestamp", - "dtx": "specificType", - "dtxp": "0", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_m4wkaqgqqjzoeh", - "meta": null, - "np": null, - "ns": null, - "order": 4, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 0, - "system": 0, - "title": "UpdatedAt", - "uidt": "DateTime", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - "cl_phvuuwjrzcdo0g": { - "ai": 1, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": null, - "clen": null, - "column_name": "id", - "cop": "1", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "int unsigned", - "deleted": null, - "dt": "int", - "dtx": "specificType", - "dtxp": "", - "dtxs": "0", - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_phvuuwjrzcdo0g", - "meta": null, - "np": "10", - "ns": "0", - "order": 1, - "pk": 1, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 1, - "system": 0, - "title": "Id", - "uidt": "ID", - "un": 1, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - } - }, - "created_at": "2023-03-02 17:04:06", - "deleted": null, - "enabled": 1, - "id": "md_rsu68aqjsbyqtl", - "meta": null, - "mm": 0, - "order": 1, - "pinned": null, - "project_id": "p_xm3thidrblw4n7", - "schema": null, - "table_name": "nc_vm5q___Table1", - "tags": null, - "title": "Table1", - "type": "table", - "updated_at": "2023-03-02 17:04:08", - "views": [ - { - "_ptn": "Table1", - "_tn": "Table1", - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:04:06", - "disabled": { - "commenter": false, - "creator": false, - "editor": false, - "guest": false, - "owner": false, - "viewer": false - }, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "vw_p2jcatxz4mvcfw", - "is_default": 1, - "lock_type": "collaborative", - "meta": {}, - "order": 1, - "password": null, - "project_id": "p_xm3thidrblw4n7", - "ptn": "nc_vm5q___Table1", - "ptype": "table", - "show": 1, - "show_system_fields": null, - "table_meta": null, - "title": "Table1", - "tn": "Table1", - "type": 3, - "updated_at": "2023-03-02 17:04:06", - "uuid": null, - "view": { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:04:06", - "fk_view_id": "vw_p2jcatxz4mvcfw", - "meta": null, - "project_id": "p_xm3thidrblw4n7", - "row_height": null, - "updated_at": "2023-03-02 17:04:06", - "uuid": null - } - } - ] - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TableReq" - } - } - } - }, - "tags": ["DB Table"], - "description": "Create a new table in a given project", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "get": { - "summary": "List Tables", - "operationId": "db-table-list", - "responses": { - "200": { - "$ref": "#/components/responses/TableList" - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - }, - { - "schema": { - "type": "number" - }, - "in": "query", - "name": "page" - }, - { - "schema": { - "type": "number" - }, - "in": "query", - "name": "pageSize" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "sort" - }, - { - "schema": { - "type": "boolean" - }, - "in": "query", - "name": "includeM2M" - } - ], - "tags": ["DB Table"], - "description": "List all tables in a given project" - } - }, - "/api/v1/db/meta/tables/{tableId}": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "md_w9gpnaousnfss1", - "type": "string" - }, - "name": "tableId", - "in": "path", - "required": true, - "description": "Unique Table ID" - } - ], - "get": { - "summary": "Read Table", - "operationId": "db-table-read", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Table" - }, - "examples": { - "Example 1": { - "value": { - "id": "md_rsu68aqjsbyqtl", - "base_id": "ds_g4ccx6e77h1dmi", - "project_id": "p_xm3thidrblw4n7", - "table_name": "nc_vm5q___Table1", - "title": "Table1", - "type": "table", - "meta": null, - "schema": null, - "enabled": 1, - "mm": 0, - "tags": null, - "pinned": null, - "deleted": null, - "order": 1, - "created_at": "2023-03-02 17:04:06", - "updated_at": "2023-03-02 17:04:08", - "columns": [ - { - "id": "cl_phvuuwjrzcdo0g", - "base_id": "ds_g4ccx6e77h1dmi", - "project_id": "p_xm3thidrblw4n7", - "fk_model_id": "md_rsu68aqjsbyqtl", - "title": "Id", - "column_name": "id", - "uidt": "ID", - "dt": "int", - "np": "10", - "ns": "0", - "clen": null, - "cop": "1", - "pk": 1, - "pv": null, - "rqd": 1, - "un": 1, - "ct": "int unsigned", - "ai": 1, - "unique": 0, - "cdf": null, - "cc": "", - "csn": null, - "dtx": "specificType", - "dtxp": "", - "dtxs": "0", - "au": 0, - "validate": null, - "virtual": null, - "deleted": null, - "system": 0, - "order": 1, - "created_at": "2023-03-02 17:04:06", - "updated_at": "2023-03-02 17:04:06", - "meta": null - }, - { - "id": "cl_c5knoi4xs4sfpt", - "base_id": "ds_g4ccx6e77h1dmi", - "project_id": "p_xm3thidrblw4n7", - "fk_model_id": "md_rsu68aqjsbyqtl", - "title": "Title", - "column_name": "title", - "uidt": "SingleLineText", - "dt": "varchar", - "np": null, - "ns": null, - "clen": "45", - "cop": "2", - "pk": 0, - "pv": 1, - "rqd": 0, - "un": 0, - "ct": "varchar(45)", - "ai": 0, - "unique": 0, - "cdf": null, - "cc": "", - "csn": "utf8mb4", - "dtx": "specificType", - "dtxp": "45", - "dtxs": null, - "au": 0, - "validate": null, - "virtual": null, - "deleted": null, - "system": 0, - "order": 2, - "created_at": "2023-03-02 17:04:06", - "updated_at": "2023-03-02 17:04:06", - "meta": null - }, - { - "id": "cl_jpl0qu4gj4rexq", - "base_id": "ds_g4ccx6e77h1dmi", - "project_id": "p_xm3thidrblw4n7", - "fk_model_id": "md_rsu68aqjsbyqtl", - "title": "CreatedAt", - "column_name": "created_at", - "uidt": "DateTime", - "dt": "timestamp", - "np": null, - "ns": null, - "clen": null, - "cop": "3", - "pk": 0, - "pv": null, - "rqd": 0, - "un": 0, - "ct": "timestamp", - "ai": 0, - "unique": 0, - "cdf": "CURRENT_TIMESTAMP", - "cc": "", - "csn": null, - "dtx": "specificType", - "dtxp": "0", - "dtxs": null, - "au": 0, - "validate": null, - "virtual": null, - "deleted": null, - "system": 0, - "order": 3, - "created_at": "2023-03-02 17:04:06", - "updated_at": "2023-03-02 17:04:06", - "meta": null - }, - { - "id": "cl_m4wkaqgqqjzoeh", - "base_id": "ds_g4ccx6e77h1dmi", - "project_id": "p_xm3thidrblw4n7", - "fk_model_id": "md_rsu68aqjsbyqtl", - "title": "UpdatedAt", - "column_name": "updated_at", - "uidt": "DateTime", - "dt": "timestamp", - "np": null, - "ns": null, - "clen": null, - "cop": "4", - "pk": 0, - "pv": null, - "rqd": 0, - "un": 0, - "ct": "timestamp", - "ai": 0, - "unique": 0, - "cdf": "CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP", - "cc": "", - "csn": null, - "dtx": "specificType", - "dtxp": "0", - "dtxs": null, - "au": 0, - "validate": null, - "virtual": null, - "deleted": null, - "system": 0, - "order": 4, - "created_at": "2023-03-02 17:04:06", - "updated_at": "2023-03-02 17:04:06", - "meta": null - } - ], - "views": [ - { - "ptn": "nc_vm5q___Table1", - "_ptn": "Table1", - "ptype": "table", - "tn": "Table1", - "_tn": "Table1", - "table_meta": null, - "id": "vw_p2jcatxz4mvcfw", - "base_id": "ds_g4ccx6e77h1dmi", - "project_id": "p_xm3thidrblw4n7", - "fk_model_id": "md_rsu68aqjsbyqtl", - "title": "Table1", - "type": 3, - "is_default": 1, - "show_system_fields": null, - "lock_type": "collaborative", - "uuid": null, - "password": null, - "show": 1, - "order": 1, - "created_at": "2023-03-02 17:04:06", - "updated_at": "2023-03-02 17:04:06", - "meta": {}, - "view": { - "fk_view_id": "vw_p2jcatxz4mvcfw", - "base_id": "ds_g4ccx6e77h1dmi", - "project_id": "p_xm3thidrblw4n7", - "uuid": null, - "created_at": "2023-03-02 17:04:06", - "updated_at": "2023-03-02 17:04:06", - "meta": null, - "row_height": null - }, - "disabled": { - "owner": false, - "creator": false, - "viewer": false, - "editor": false, - "commenter": false, - "guest": false - } - } - ], - "columnsById": { - "cl_phvuuwjrzcdo0g": { - "id": "cl_phvuuwjrzcdo0g", - "base_id": "ds_g4ccx6e77h1dmi", - "project_id": "p_xm3thidrblw4n7", - "fk_model_id": "md_rsu68aqjsbyqtl", - "title": "Id", - "column_name": "id", - "uidt": "ID", - "dt": "int", - "np": "10", - "ns": "0", - "clen": null, - "cop": "1", - "pk": 1, - "pv": null, - "rqd": 1, - "un": 1, - "ct": "int unsigned", - "ai": 1, - "unique": 0, - "cdf": null, - "cc": "", - "csn": null, - "dtx": "specificType", - "dtxp": "", - "dtxs": "0", - "au": 0, - "validate": null, - "virtual": null, - "deleted": null, - "system": 0, - "order": 1, - "created_at": "2023-03-02 17:04:06", - "updated_at": "2023-03-02 17:04:06", - "meta": null - }, - "cl_c5knoi4xs4sfpt": { - "id": "cl_c5knoi4xs4sfpt", - "base_id": "ds_g4ccx6e77h1dmi", - "project_id": "p_xm3thidrblw4n7", - "fk_model_id": "md_rsu68aqjsbyqtl", - "title": "Title", - "column_name": "title", - "uidt": "SingleLineText", - "dt": "varchar", - "np": null, - "ns": null, - "clen": "45", - "cop": "2", - "pk": 0, - "pv": 1, - "rqd": 0, - "un": 0, - "ct": "varchar(45)", - "ai": 0, - "unique": 0, - "cdf": null, - "cc": "", - "csn": "utf8mb4", - "dtx": "specificType", - "dtxp": "45", - "dtxs": null, - "au": 0, - "validate": null, - "virtual": null, - "deleted": null, - "system": 0, - "order": 2, - "created_at": "2023-03-02 17:04:06", - "updated_at": "2023-03-02 17:04:06", - "meta": null - }, - "cl_jpl0qu4gj4rexq": { - "id": "cl_jpl0qu4gj4rexq", - "base_id": "ds_g4ccx6e77h1dmi", - "project_id": "p_xm3thidrblw4n7", - "fk_model_id": "md_rsu68aqjsbyqtl", - "title": "CreatedAt", - "column_name": "created_at", - "uidt": "DateTime", - "dt": "timestamp", - "np": null, - "ns": null, - "clen": null, - "cop": "3", - "pk": 0, - "pv": null, - "rqd": 0, - "un": 0, - "ct": "timestamp", - "ai": 0, - "unique": 0, - "cdf": "CURRENT_TIMESTAMP", - "cc": "", - "csn": null, - "dtx": "specificType", - "dtxp": "0", - "dtxs": null, - "au": 0, - "validate": null, - "virtual": null, - "deleted": null, - "system": 0, - "order": 3, - "created_at": "2023-03-02 17:04:06", - "updated_at": "2023-03-02 17:04:06", - "meta": null - }, - "cl_m4wkaqgqqjzoeh": { - "id": "cl_m4wkaqgqqjzoeh", - "base_id": "ds_g4ccx6e77h1dmi", - "project_id": "p_xm3thidrblw4n7", - "fk_model_id": "md_rsu68aqjsbyqtl", - "title": "UpdatedAt", - "column_name": "updated_at", - "uidt": "DateTime", - "dt": "timestamp", - "np": null, - "ns": null, - "clen": null, - "cop": "4", - "pk": 0, - "pv": null, - "rqd": 0, - "un": 0, - "ct": "timestamp", - "ai": 0, - "unique": 0, - "cdf": "CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP", - "cc": "", - "csn": null, - "dtx": "specificType", - "dtxp": "0", - "dtxs": null, - "au": 0, - "validate": null, - "virtual": null, - "deleted": null, - "system": 0, - "order": 4, - "created_at": "2023-03-02 17:04:06", - "updated_at": "2023-03-02 17:04:06", - "meta": null - } - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table"], - "description": "Read the table meta data by the given table ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "patch": { - "summary": "Update Table", - "operationId": "db-table-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "5a0g9yvs4e678" - }, - "example": "The table has been updated successfully" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "The table has been updated successfully" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "table_name": { - "type": "string", - "description": "Table name", - "example": "users" - }, - "title": { - "type": "string", - "description": "Table title", - "example": "Users" - }, - "project_id": { - "type": "string", - "description": "Project ID", - "example": "p_124hhlkbeasewh" - }, - "meta": { - "$ref": "#/components/schemas/Meta" - } - } - }, - "examples": { - "Example 1": { - "value": { - "table_name": "users", - "title": "Users", - "project_id": "p_124hhlkbeasewh", - "meta": null - } - } - } - } - } - }, - "description": "Update the table meta data by the given table ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "delete": { - "summary": "Delete Table", - "operationId": "db-table-delete", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "boolean" - }, - "examples": { - "Example 1": { - "value": true - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table"], - "description": "Delete the table meta data by the given table ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/projects/{projectId}/{baseId}/tables": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - }, - { - "schema": { - "type": "string", - "pattern": "ds_j04jmxh5xg10lu" - }, - "name": "baseId", - "in": "path", - "required": true, - "description": "Unique Base ID" - } - ], - "get": { - "summary": "List Tables", - "operationId": "table-list", - "responses": { - "200": { - "$ref": "#/components/responses/TableList" - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - }, - { - "schema": { - "type": "number" - }, - "in": "query", - "name": "page" - }, - { - "schema": { - "type": "number" - }, - "in": "query", - "name": "pageSize" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "sort" - }, - { - "schema": { - "type": "boolean" - }, - "in": "query", - "name": "includeM2M" - } - ], - "tags": ["Base"], - "description": "List all tables in a given Project and Base" - }, - "post": { - "summary": "Create Table", - "operationId": "table-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Table" - }, - "examples": { - "Example 1": { - "value": { - "base_id": "ds_g4ccx6e77h1dmi", - "columns": [ - { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": "CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP", - "clen": null, - "column_name": "updated_at", - "cop": "4", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "timestamp", - "deleted": null, - "dt": "timestamp", - "dtx": "specificType", - "dtxp": "0", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_m4wkaqgqqjzoeh", - "meta": null, - "np": null, - "ns": null, - "order": 4, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 0, - "system": 0, - "title": "UpdatedAt", - "uidt": "DateTime", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": "CURRENT_TIMESTAMP", - "clen": null, - "column_name": "created_at", - "cop": "3", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "timestamp", - "deleted": null, - "dt": "timestamp", - "dtx": "specificType", - "dtxp": "0", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_jpl0qu4gj4rexq", - "meta": null, - "np": null, - "ns": null, - "order": 3, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 0, - "system": 0, - "title": "CreatedAt", - "uidt": "DateTime", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": null, - "clen": "45", - "column_name": "title", - "cop": "2", - "created_at": "2023-03-02 17:04:06", - "csn": "utf8mb4", - "ct": "varchar(45)", - "deleted": null, - "dt": "varchar", - "dtx": "specificType", - "dtxp": "45", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_c5knoi4xs4sfpt", - "meta": null, - "np": null, - "ns": null, - "order": 2, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": 1, - "rqd": 0, - "system": 0, - "title": "Title", - "uidt": "SingleLineText", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - { - "ai": 1, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": null, - "clen": null, - "column_name": "id", - "cop": "1", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "int unsigned", - "deleted": null, - "dt": "int", - "dtx": "specificType", - "dtxp": "", - "dtxs": "0", - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_phvuuwjrzcdo0g", - "meta": null, - "np": "10", - "ns": "0", - "order": 1, - "pk": 1, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 1, - "system": 0, - "title": "Id", - "uidt": "ID", - "un": 1, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - } - ], - "columnsById": { - "cl_c5knoi4xs4sfpt": { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": null, - "clen": "45", - "column_name": "title", - "cop": "2", - "created_at": "2023-03-02 17:04:06", - "csn": "utf8mb4", - "ct": "varchar(45)", - "deleted": null, - "dt": "varchar", - "dtx": "specificType", - "dtxp": "45", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_c5knoi4xs4sfpt", - "meta": null, - "np": null, - "ns": null, - "order": 2, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": 1, - "rqd": 0, - "system": 0, - "title": "Title", - "uidt": "SingleLineText", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - "cl_jpl0qu4gj4rexq": { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": "CURRENT_TIMESTAMP", - "clen": null, - "column_name": "created_at", - "cop": "3", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "timestamp", - "deleted": null, - "dt": "timestamp", - "dtx": "specificType", - "dtxp": "0", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_jpl0qu4gj4rexq", - "meta": null, - "np": null, - "ns": null, - "order": 3, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 0, - "system": 0, - "title": "CreatedAt", - "uidt": "DateTime", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - "cl_m4wkaqgqqjzoeh": { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": "CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP", - "clen": null, - "column_name": "updated_at", - "cop": "4", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "timestamp", - "deleted": null, - "dt": "timestamp", - "dtx": "specificType", - "dtxp": "0", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_m4wkaqgqqjzoeh", - "meta": null, - "np": null, - "ns": null, - "order": 4, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 0, - "system": 0, - "title": "UpdatedAt", - "uidt": "DateTime", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - "cl_phvuuwjrzcdo0g": { - "ai": 1, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": null, - "clen": null, - "column_name": "id", - "cop": "1", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "int unsigned", - "deleted": null, - "dt": "int", - "dtx": "specificType", - "dtxp": "", - "dtxs": "0", - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_phvuuwjrzcdo0g", - "meta": null, - "np": "10", - "ns": "0", - "order": 1, - "pk": 1, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 1, - "system": 0, - "title": "Id", - "uidt": "ID", - "un": 1, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - } - }, - "created_at": "2023-03-02 17:04:06", - "deleted": null, - "enabled": 1, - "id": "md_rsu68aqjsbyqtl", - "meta": null, - "mm": 0, - "order": 1, - "pinned": null, - "project_id": "p_xm3thidrblw4n7", - "schema": null, - "table_name": "nc_vm5q___Table1", - "tags": null, - "title": "Table1", - "type": "table", - "updated_at": "2023-03-02 17:04:08", - "views": [ - { - "_ptn": "Table1", - "_tn": "Table1", - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:04:06", - "disabled": { - "commenter": false, - "creator": false, - "editor": false, - "guest": false, - "owner": false, - "viewer": false - }, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "vw_p2jcatxz4mvcfw", - "is_default": 1, - "lock_type": "collaborative", - "meta": {}, - "order": 1, - "password": null, - "project_id": "p_xm3thidrblw4n7", - "ptn": "nc_vm5q___Table1", - "ptype": "table", - "show": 1, - "show_system_fields": null, - "table_meta": null, - "title": "Table1", - "tn": "Table1", - "type": 3, - "updated_at": "2023-03-02 17:04:06", - "uuid": null, - "view": { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:04:06", - "fk_view_id": "vw_p2jcatxz4mvcfw", - "meta": null, - "project_id": "p_xm3thidrblw4n7", - "row_height": null, - "updated_at": "2023-03-02 17:04:06", - "uuid": null - } - } - ] - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TableReq" - }, - "examples": { - "Example 1": { - "value": { - "columns": [ - { - "ai": false, - "altered": 1, - "cdf": "CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP", - "ck": false, - "clen": 45, - "column_name": "updated_at", - "ct": "varchar(45)", - "dt": "timestamp", - "dtx": "specificType", - "dtxp": "", - "dtxs": "", - "np": null, - "nrqd": true, - "ns": null, - "pk": false, - "rqd": false, - "title": "UpdatedAt", - "uicn": "", - "uidt": "DateTime", - "uip": "", - "un": false - }, - { - "ai": false, - "altered": 1, - "cdf": "CURRENT_TIMESTAMP", - "ck": false, - "clen": 45, - "column_name": "created_at", - "ct": "varchar(45)", - "dt": "timestamp", - "dtx": "specificType", - "dtxp": "", - "dtxs": "", - "np": null, - "nrqd": true, - "ns": null, - "pk": false, - "rqd": false, - "title": "CreatedAt", - "uicn": "", - "uidt": "DateTime", - "uip": "", - "un": false - }, - { - "ai": false, - "altered": 1, - "cdf": null, - "ck": false, - "clen": 45, - "column_name": "title", - "ct": "varchar(45)", - "dt": "varchar", - "dtx": "specificType", - "dtxp": "45", - "dtxs": "", - "np": null, - "nrqd": true, - "ns": null, - "pk": false, - "rqd": false, - "title": "Title", - "uicn": "", - "uidt": "SingleLineText", - "uip": "", - "un": false - }, - { - "ai": true, - "altered": 1, - "cdf": null, - "ck": false, - "clen": null, - "column_name": "id", - "ct": "int(11)", - "dt": "int", - "dtx": "integer", - "dtxp": "11", - "dtxs": "", - "np": 11, - "nrqd": false, - "ns": 0, - "pk": true, - "rqd": true, - "title": "Id", - "uicn": "", - "uidt": "ID", - "uip": "", - "un": true - } - ], - "table_name": "Sheet-1", - "title": "Sheet-1" - } - } - } - } - } - }, - "tags": ["Base"], - "description": "Create a new table in a given Project and Base", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/tables/{tableId}/reorder": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "md_w9gpnaousnfss1", - "type": "string" - }, - "name": "tableId", - "in": "path", - "required": true, - "description": "Unique Table ID" - } - ], - "post": { - "summary": "Reorder Table", - "operationId": "db-table-reorder", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "boolean" - }, - "examples": { - "Example 1": { - "value": true - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "order": { - "type": "number" - } - } - }, - "examples": { - "Example 1": { - "value": { - "order": 0 - } - } - } - } - } - }, - "tags": ["DB Table"], - "description": "Update the order of the given Table", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/tables/{tableId}/columns": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "md_w9gpnaousnfss1", - "type": "string" - }, - "name": "tableId", - "in": "path", - "required": true, - "description": "Unique Table ID" - } - ], - "post": { - "summary": "Create Column", - "operationId": "db-table-column-create", - "responses": { - "200": { - "description": "OK" - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ColumnReq" - }, - "examples": { - "Example 1": { - "value": { - "ai": 0, - "au": 0, - "base_id": "ds_krsappzu9f8vmo", - "cc": "", - "cdf": null, - "clen": "45", - "column_name": "title", - "cop": "2", - "csn": "utf8mb4", - "ct": "varchar(45)", - "deleted": null, - "dt": "varchar", - "dtx": "specificType", - "dtxp": "45", - "dtxs": null, - "fk_model_id": "md_yvwvbt2i78rgcm", - "id": "cl_0j9gv0oi8vjy46", - "meta": null, - "np": null, - "ns": null, - "order": 2, - "pk": 0, - "project_id": "p_01clqvzik3izk6", - "pv": 1, - "rqd": 0, - "system": 0, - "title": "Title", - "uidt": "SingleLineText", - "un": 0, - "unique": 0, - "validate": null, - "virtual": null - } - } - } - } - } - }, - "tags": ["DB Table Column"], - "description": "Create a new column in a given Table", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/columns/{columnId}": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "columnId", - "in": "path", - "required": true - } - ], - "patch": { - "summary": "Update Column", - "operationId": "db-table-column-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Column" - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ColumnReq" - } - } - } - }, - "tags": ["DB Table Column"], - "description": "Update the existing column by the given column ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "delete": { - "summary": "Delete Column", - "operationId": "db-table-column-delete", - "responses": { - "200": { - "description": "OK" - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Column"], - "description": "Delete the existing column by the given column ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "get": { - "summary": "Get Column", - "operationId": "db-table-column-get", - "responses": { - "200": { - "description": "OK" - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Column"], - "description": "Get the existing column by the given column ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/columns/{columnId}/primary": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "columnId", - "in": "path", - "required": true - } - ], - "post": { - "summary": "Create Primary Value", - "operationId": "db-table-column-primary-column-set", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "boolean" - }, - "examples": { - "Example 1": { - "value": true - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Column"], - "description": "Set a primary value on a given column", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/tables/{tableId}/views": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "md_w9gpnaousnfss1", - "type": "string" - }, - "name": "tableId", - "in": "path", - "required": true, - "description": "Unique Table ID" - } - ], - "get": { - "summary": "List Views", - "operationId": "db-view-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ViewList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "alias": "string", - "column": [ - { - "alias": "string", - "auto_increment": true, - "auto_update_timestamp": true, - "base_id": "string", - "character_maximum_length": "string", - "character_set_name": "string", - "colOptions": { - "deleted": "string", - "dr": "string", - "fk_child_column_id": "string", - "fk_column_id": "string", - "fk_index_name": "string", - "fk_mm_child_column_id": "string", - "fk_mm_model_id": "string", - "fk_mm_parent_column_id": "string", - "fk_parent_column_id": "string", - "id": "string", - "order": "string", - "type": "string", - "ur": "string", - "virtual": true - }, - "column_comment": "string", - "column_default": "string", - "column_ordinal_position": "string", - "column_type": "string", - "data_type": "string", - "data_type_x": "string", - "data_type_x_precision": "string", - "data_type_x_scale": "string", - "deleted": true, - "fk_model_id": "string", - "id": "string", - "numeric_precision": "string", - "numeric_scale": "string", - "order": 0, - "primary_key": true, - "primary_value": true, - "rqd": "string", - "title": "string", - "ui_data_type": "string", - "un": "string", - "unique": true, - "visible": true - } - ], - "columnByIds": {}, - "deleted": true, - "enabled": true, - "fk_base_id": "string", - "fk_project_id": "string", - "id": "string", - "order": 0, - "parent_id": "string", - "pinned": true, - "show_as": "string", - "tags": "string", - "title": "string", - "type": "string" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "description": "List all views in a given Table.", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/views/{viewId}": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "vw_wtdg2meyig5l4q" - }, - "name": "viewId", - "in": "path", - "required": true, - "description": "Unique View ID" - } - ], - "patch": { - "summary": "Update View", - "operationId": "db-view-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/View" - }, - "examples": { - "Example 1": { - "value": { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:46:31", - "fk_model_id": "md_mhs9z4r2ak98x0", - "id": "vw_lg052cnc1c26kf", - "is_default": 1, - "lock_type": "collaborative", - "meta": "{\"allowCSVDownload\":true}", - "order": 1, - "password": "password123", - "project_id": "p_xm3thidrblw4n7", - "show": 1, - "show_system_fields": null, - "title": "Grid View 1", - "type": 3, - "updated_at": "2023-03-02 17:46:31", - "uuid": null - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ViewUpdateReq" - }, - "examples": { - "Example 1": { - "value": { - "title": "Grid View 1", - "uuid": "e2457bbf-e29c-4fec-866e-fe3b01dba57f", - "password": "password123", - "lock_type": "collaborative", - "meta": "{\"allowCSVDownload\":true}", - "order": 1, - "show_system_fields": 0 - } - } - } - } - } - }, - "tags": ["DB View"], - "description": "Update the view with the given view Id.", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "delete": { - "summary": "Delete View", - "operationId": "db-view-delete", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "boolean" - }, - "examples": { - "Example 1": { - "value": true - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "description": "Delete the view with the given view Id.", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/views/{viewId}/show-all": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "vw_wtdg2meyig5l4q" - }, - "name": "viewId", - "in": "path", - "required": true, - "description": "Unique View ID" - } - ], - "post": { - "summary": "Show All Columns In View", - "operationId": "db-view-show-all-column", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "boolean" - }, - "examples": { - "Example 1": { - "value": true - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "description": "Show All Columns in a given View", - "parameters": [ - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "ignoreIds" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/views/{viewId}/hide-all": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "vw_wtdg2meyig5l4q" - }, - "name": "viewId", - "in": "path", - "required": true, - "description": "Unique View ID" - } - ], - "post": { - "summary": "Hide All Columns In View", - "operationId": "db-view-hide-all-column", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "boolean" - }, - "examples": { - "Example 1": { - "value": true - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "parameters": [ - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "ignoreIds" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "description": "Hide All Columns in a given View" - } - }, - "/api/v1/db/meta/tables/{tableId}/share": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "md_w9gpnaousnfss1", - "type": "string" - }, - "name": "tableId", - "in": "path", - "required": true, - "description": "Unique Table ID" - } - ], - "get": { - "summary": "List Shared Views", - "operationId": "db-view-share-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SharedViewList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:46:31", - "fk_model_id": "md_mhs9z4r2ak98x0", - "id": "vw_lg052cnc1c26kf", - "is_default": 1, - "lock_type": "collaborative", - "meta": {}, - "order": 1, - "project_id": "p_xm3thidrblw4n7", - "show": 1, - "show_system_fields": null, - "title": "Sheet-1", - "type": 3, - "updated_at": "2023-03-02 17:46:31", - "uuid": null, - "view": { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:46:31", - "fk_view_id": "vw_lg052cnc1c26kf", - "meta": null, - "project_id": "p_xm3thidrblw4n7", - "row_height": null, - "updated_at": "2023-03-02 17:46:31", - "uuid": null - } - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "List all shared views in a given Table", - "tags": ["DB View Share"], - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/views/{viewId}/share": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "vw_wtdg2meyig5l4q" - }, - "name": "viewId", - "in": "path", - "required": true, - "description": "Unique View ID" - } - ], - "post": { - "summary": "Create Shared View", - "operationId": "db-view-share-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SharedViewReq" - }, - "examples": { - "Example 1": { - "value": { - "meta": {}, - "password": "123456789" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View Share"], - "description": "Create a shared view in a given View..", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "patch": { - "summary": "Update Shared View", - "operationId": "db-view-share-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SharedView" - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SharedViewReq" - } - } - }, - "description": "" - }, - "tags": ["DB View Share"], - "description": "Update a shared view in a given View..", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "delete": { - "summary": "Delete Shared View", - "operationId": "db-view-share-delete", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "boolean" - }, - "examples": { - "Example 1": { - "value": true - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Delete a shared view in a given View.", - "tags": ["DB View Share"], - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/views/{viewId}/columns": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "vw_wtdg2meyig5l4q" - }, - "name": "viewId", - "in": "path", - "required": true, - "description": "Unique View ID" - } - ], - "get": { - "summary": "List Columns In View", - "operationId": "db-view-column-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ColumnList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "ai": 0, - "au": 0, - "base_id": "ds_krsappzu9f8vmo", - "cc": "", - "cdf": null, - "clen": "45", - "column_name": "title", - "cop": "2", - "created_at": "2023-03-02 13:14:16", - "csn": "utf8mb4", - "ct": "varchar(45)", - "deleted": null, - "dt": "varchar", - "dtx": "specificType", - "dtxp": "45", - "dtxs": null, - "fk_model_id": "md_yvwvbt2i78rgcm", - "id": "cl_0j9gv0oi8vjy46", - "meta": null, - "np": null, - "ns": null, - "order": 2, - "pk": 0, - "project_id": "p_01clqvzik3izk6", - "pv": 1, - "rqd": 0, - "system": 0, - "title": "Title", - "uidt": "SingleLineText", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 13:14:16", - "validate": null, - "virtual": null - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View Column"], - "description": "List all columns by ViewID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "post": { - "summary": "Create Column in View", - "operationId": "db-view-column-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Column" - }, - "examples": { - "Example 1": { - "value": { - "ai": 0, - "au": 0, - "base_id": "ds_krsappzu9f8vmo", - "cc": "", - "cdf": null, - "clen": "45", - "column_name": "title", - "cop": "2", - "created_at": "2023-03-02 13:14:16", - "csn": "utf8mb4", - "ct": "varchar(45)", - "deleted": null, - "dt": "varchar", - "dtx": "specificType", - "dtxp": "45", - "dtxs": null, - "fk_model_id": "md_yvwvbt2i78rgcm", - "id": "cl_0j9gv0oi8vjy46", - "meta": null, - "np": null, - "ns": null, - "order": 2, - "pk": 0, - "project_id": "p_01clqvzik3izk6", - "pv": 1, - "rqd": 0, - "system": 0, - "title": "Title", - "uidt": "SingleLineText", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 13:14:16", - "validate": null, - "virtual": null - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View Column"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ViewColumnReq" - }, - "examples": { - "Example 1": { - "value": { - "fk_column_id": "cl_m4wkaqgqqjzoeh", - "show": 0, - "order": 1 - } - } - } - } - } - }, - "description": "Create a new column in a given View", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/views/{viewId}/columns/{columnId}": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "vw_wtdg2meyig5l4q" - }, - "name": "viewId", - "in": "path", - "required": true - }, - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "cl_8iw2o4ejzvdyna", - "type": "string" - }, - "name": "columnId", - "in": "path", - "required": true, - "description": "Unique Column ID" - } - ], - "patch": { - "summary": "Update View Column", - "operationId": "db-view-column-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number" - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View Column"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ViewColumnUpdateReq" - }, - "examples": { - "Example 1": { - "value": { - "show": 0, - "order": 1 - } - } - } - } - } - }, - "description": "Update a column in a View", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/views/{viewId}/sorts": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "vw_wtdg2meyig5l4q" - }, - "name": "viewId", - "in": "path", - "required": true, - "description": "Unique View ID" - } - ], - "get": { - "summary": "List View Sorts", - "operationId": "db-table-sort-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SortList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "id": "so_xd4t51uv60ghzl", - "fk_column_id": "cl_l11b769pe2j1ce", - "fk_model_id": "md_ehn5izr99m7d45", - "base_id": "ds_3l9qx8xqksenrl", - "direction": "desc", - "order": 1, - "project_id": "p_9sx43moxhqtjm3" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Sort"], - "description": "List all the sort data in a given View", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "post": { - "summary": "Update View Sort", - "operationId": "db-table-sort-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number" - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Sort"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/SortReq" - }, - { - "type": "object", - "properties": { - "push_to_top": { - "type": "boolean", - "example": true, - "description": "Push the sort to the top of the list" - } - } - } - ] - } - } - } - }, - "description": "Update the sort data in a given View", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/sorts/{sortId}": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "so_xd4t51uv60ghzl" - }, - "name": "sortId", - "in": "path", - "description": "Unique Sort ID", - "required": true - } - ], - "get": { - "summary": "Get Sort", - "operationId": "db-table-sort-get", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Sort" - }, - "examples": { - "Example 1": { - "value": { - "id": "so_xd4t51uv60ghzl", - "fk_column_id": "cl_l11b769pe2j1ce", - "fk_model_id": "md_ehn5izr99m7d45", - "base_id": "ds_3l9qx8xqksenrl", - "direction": "desc", - "order": 1, - "project_id": "p_9sx43moxhqtjm3" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Sort"], - "description": "Get the sort data by Sort ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "patch": { - "summary": "Update Sort", - "operationId": "db-table-sort-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number", - "example": 1 - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Sort"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SortReq" - }, - "examples": { - "Example 1": { - "value": { - "direction": "asc", - "fk_column_id": "cl_l11b769pe2j1ce" - } - } - } - } - } - }, - "description": "Update the sort data by Sort ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "delete": { - "summary": "Delete Sort", - "operationId": "db-table-sort-delete", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "boolean" - }, - "examples": { - "Example 1": { - "value": true - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Sort"], - "description": "Delete the sort data by Sort ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/views/{viewId}/filters": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "vw_wtdg2meyig5l4q" - }, - "name": "viewId", - "in": "path", - "required": true, - "description": "Unique View ID" - } - ], - "get": { - "summary": "Get View Filter", - "operationId": "db-table-filter-read", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FilterList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "comparison_op": "eq", - "comparison_sub_op": null, - "created_at": "2023-03-02 18:18:05", - "fk_column_id": "cl_d7ah9n2qfupgys", - "fk_hook_id": null, - "fk_parent_id": null, - "fk_view_id": "vw_b739e29vqmrxnf", - "id": "fi_xn647tpmdq8fu8", - "is_group": null, - "logical_op": "and", - "order": 1, - "project_id": "p_xm3thidrblw4n7", - "updated_at": "2023-03-02 18:18:05", - "value": "foo" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Filter"], - "description": "Get the filter data in a given View", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "post": { - "summary": "Create View Filter", - "operationId": "db-table-filter-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Filter" - }, - "examples": { - "Example 1": { - "value": { - "base_id": "ds_g4ccx6e77h1dmi", - "comparison_op": "eq", - "comparison_sub_op": null, - "created_at": "2023-03-02 18:18:05", - "fk_column_id": "cl_d7ah9n2qfupgys", - "fk_hook_id": null, - "fk_parent_id": null, - "fk_view_id": "vw_b739e29vqmrxnf", - "id": "fi_xn647tpmdq8fu8", - "is_group": null, - "logical_op": "and", - "order": 1, - "project_id": "p_xm3thidrblw4n7", - "updated_at": "2023-03-02 18:18:05", - "value": "foo" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Filter"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FilterReq" - }, - "examples": { - "Example 1": { - "value": { - "comparison_op": "eq", - "comparison_sub_op": null, - "fk_column_id": "cl_d7ah9n2qfupgys", - "is_group": false, - "logical_op": "and", - "value": "foo" - } - } - } - } - } - }, - "description": "Update the filter data in a given View", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/hooks/{hookId}/filters": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "hk_0063k4o1frnxbr" - }, - "name": "hookId", - "in": "path", - "required": true, - "description": "Unique Hook ID" - } - ], - "get": { - "summary": "Get Hook Filter", - "operationId": "db-table-webhook-filter-read", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FilterList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "comparison_op": "eq", - "comparison_sub_op": null, - "created_at": "2023-03-02 18:18:05", - "fk_column_id": "cl_d7ah9n2qfupgys", - "fk_hook_id": null, - "fk_parent_id": null, - "fk_view_id": "vw_b739e29vqmrxnf", - "id": "fi_xn647tpmdq8fu8", - "is_group": null, - "logical_op": "and", - "order": 1, - "project_id": "p_xm3thidrblw4n7", - "updated_at": "2023-03-02 18:18:05", - "value": "foo" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Webhook Filter"], - "description": "Get the filter data in a given Hook", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "post": { - "summary": "Create Hook Filter", - "operationId": "db-table-webhook-filter-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Filter" - }, - "examples": { - "Example 1": { - "value": { - "base_id": "ds_g4ccx6e77h1dmi", - "comparison_op": "eq", - "comparison_sub_op": null, - "created_at": "2023-03-02 18:18:05", - "fk_column_id": "cl_d7ah9n2qfupgys", - "fk_hook_id": null, - "fk_parent_id": null, - "fk_view_id": "vw_b739e29vqmrxnf", - "id": "fi_xn647tpmdq8fu8", - "is_group": null, - "logical_op": "and", - "order": 1, - "project_id": "p_xm3thidrblw4n7", - "updated_at": "2023-03-02 18:18:05", - "value": "foo" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Webhook Filter"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FilterReq" - }, - "examples": { - "Example 1": { - "value": { - "comparison_op": "eq", - "comparison_sub_op": null, - "fk_column_id": "cl_d7ah9n2qfupgys", - "is_group": false, - "logical_op": "and", - "value": "foo" - } - } - } - } - } - }, - "description": "Create filter(s) in a given Hook", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/hooks/{hookId}/logs": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "hk_0063k4o1frnxbr" - }, - "name": "hookId", - "in": "path", - "required": true, - "description": "Unique Hook ID" - } - ], - "get": { - "summary": "List Hook Logs", - "operationId": "db-table-webhook-logs-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HookLogList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "base_id": "ds_jxuewivwbxeum2", - "event": "after", - "execution_time": "98", - "fk_hook_id": "hk_035ijv5qdi97y5", - "id": "string", - "notifications": "{\"type\":\"URL\",\"payload\":{\"method\":\"POST\",\"body\":\"{{ json data }}\",\"headers\":[{}],\"parameters\":[{}],\"auth\":\"\",\"path\":\"https://webhook.site/6eb45ce5-b611-4be1-8b96-c2965755662b\"}}", - "operation": "insert", - "payload": "{\"method\":\"POST\",\"body\":\"{{ json data }}\",\"headers\":[{}],\"parameters\":[{}],\"auth\":\"\",\"path\":\"https://webhook.site/6eb45ce5-b611-4be1-8b96-c2965755662b\"}", - "project_id": "p_tbhl1hnycvhe5l", - "response": "{\"status\":200,\"statusText\":\"OK\",\"headers\":{\"server\":\"nginx\",\"content-type\":\"text/plain; charset=UTF-8\",\"transfer-encoding\":\"chunked\",\"connection\":\"close\",\"vary\":\"Accept-Encoding\",\"x-request-id\":\"53844a7d-ede8-4798-adf7-8af441908a72\",\"x-token-id\":\"6eb45ce5-b611-4be1-8b96-c2965755662b\",\"cache-control\":\"no-cache, private\",\"date\":\"Fri, 24 Mar 2023 10:50:10 GMT\"},\"config\":{\"url\":\"https://webhook.site/6eb45ce5-b611-4be1-8b96-c2965755662b\",\"method\":\"post\",\"data\":\"{\\\"type\\\":\\\"records.after.insert\\\",\\\"id\\\":\\\"a77d97dc-a3e4-4719-9b46-45f93e0cc99a\\\",\\\"data\\\":{\\\"table_id\\\":\\\"md_d8v403o74mf5lf\\\",\\\"table_name\\\":\\\"Sheet-2\\\"}}\",\"headers\":{\"Accept\":\"application/json, text/plain, */*\",\"Content-Type\":\"application/x-www-form-urlencoded\",\"User-Agent\":\"axios/0.21.4\",\"Content-Length\":138},\"params\":{}}}", - "test_call": 0, - "triggered_by": "w@nocodb.com", - "type": "URL" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Webhook Logs"], - "description": "List the log data in a given Hook", - "parameters": [ - { - "schema": { - "type": "integer", - "minimum": 1 - }, - "in": "query", - "name": "limit" - }, - { - "schema": { - "type": "integer", - "minimum": 0 - }, - "in": "query", - "name": "offset" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/filters/{filterId}": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "pattern": "fi_pgfuo11uhn2xeo" - }, - "name": "filterId", - "in": "path", - "required": true, - "description": "Unique Filter ID" - } - ], - "get": { - "summary": "Get Filter", - "operationId": "db-table-filter-get", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Filter" - }, - "examples": { - "Example 1": { - "value": { - "base_id": "ds_g4ccx6e77h1dmi", - "comparison_op": "eq", - "comparison_sub_op": null, - "created_at": "2023-03-02 18:18:05", - "fk_column_id": "cl_d7ah9n2qfupgys", - "fk_hook_id": null, - "fk_parent_id": null, - "fk_view_id": "vw_b739e29vqmrxnf", - "id": "fi_xn647tpmdq8fu8", - "is_group": null, - "logical_op": "and", - "order": 1, - "project_id": "p_xm3thidrblw4n7", - "updated_at": "2023-03-02 18:18:05", - "value": "foo" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Filter"], - "description": "Get the filter data with a given Filter ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "patch": { - "summary": "Update Filter", - "operationId": "db-table-filter-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number" - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Filter"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FilterReq" - }, - "examples": { - "Example 1": { - "value": { - "comparison_op": "eq", - "comparison_sub_op": null, - "fk_column_id": "cl_d7ah9n2qfupgys", - "is_group": false, - "logical_op": "and", - "value": "foo" - } - } - } - } - } - }, - "description": "Update the filter data with a given Filter ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "delete": { - "summary": "Delete Filter", - "operationId": "db-table-filter-delete", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "boolean" - }, - "examples": { - "Example 1": { - "value": true - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Filter"], - "description": "Delete the filter data with a given Filter ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/filters/{filterGroupId}/children": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "fi_pgfuo11uhn2xeo", - "description": "Filter Group ID" - }, - "name": "filterGroupId", - "in": "path", - "required": true - } - ], - "get": { - "summary": "Get Filter Group Children", - "operationId": "db-table-filter-children-read", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FilterList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "comparison_op": "eq", - "comparison_sub_op": null, - "created_at": "2023-03-02 18:18:05", - "fk_column_id": "cl_d7ah9n2qfupgys", - "fk_hook_id": null, - "fk_parent_id": null, - "fk_view_id": "vw_b739e29vqmrxnf", - "id": "fi_xn647tpmdq8fu8", - "is_group": null, - "logical_op": "and", - "order": 1, - "project_id": "p_xm3thidrblw4n7", - "updated_at": "2023-03-02 18:18:05", - "value": "foo" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Filter"], - "description": "Get Filter Group Children of a given group ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/tables/{tableId}/grids": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "md_w9gpnaousnfss1", - "type": "string" - }, - "name": "tableId", - "in": "path", - "required": true, - "description": "Unique Table ID" - } - ], - "post": { - "summary": "Create Grid View", - "operationId": "db-view-grid-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/View" - }, - "examples": { - "Example 1": { - "value": { - "id": "vw_o50jiw9v2txktv", - "base_id": "ds_a95vextjl510z7", - "project_id": "p_slkm6i3v31q4bc", - "fk_model_id": "md_8hr3xndx8umuce", - "title": "Grid-1", - "type": 3, - "is_default": null, - "show_system_fields": null, - "lock_type": "collaborative", - "uuid": null, - "password": null, - "show": true, - "order": 2, - "created_at": "2023-03-13T07:29:16.610Z", - "updated_at": "2023-03-13T07:29:16.610Z", - "meta": {} - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ViewCreateReq" - }, - "examples": { - "Example 1": { - "value": { - "title": "My Grid View", - "type": 3, - "copy_from_id": null, - "fk_grp_col_id": null, - "fk_geo_data_col_id": null - } - } - } - } - } - }, - "description": "Create a new grid view in a given Table", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/tables/{tableId}/forms": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "md_w9gpnaousnfss1", - "type": "string" - }, - "name": "tableId", - "in": "path", - "required": true, - "description": "Unique Table ID" - } - ], - "post": { - "summary": "Create Form View", - "operationId": "db-view-form-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/View" - }, - "examples": { - "Example 1": { - "value": { - "id": "vw_a830n4bmwk8wlp", - "base_id": "ds_a95vextjl510z7", - "project_id": "p_slkm6i3v31q4bc", - "fk_model_id": "md_8hr3xndx8umuce", - "title": "Form-1", - "type": 1, - "is_default": null, - "show_system_fields": null, - "lock_type": "collaborative", - "uuid": null, - "password": null, - "show": true, - "order": 4, - "created_at": "2023-03-13T07:29:19.957Z", - "updated_at": "2023-03-13T07:29:19.957Z", - "meta": {} - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Create a new form view in a given Table", - "tags": ["DB View"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ViewCreateReq" - }, - "examples": { - "Example 1": { - "value": { - "title": "My Form View", - "type": 1, - "copy_from_id": null, - "fk_grp_col_id": null, - "fk_geo_data_col_id": null - } - } - } - } - } - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/forms/{formViewId}": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "vw_6fqln9vdytdv8q" - }, - "name": "formViewId", - "in": "path", - "required": true, - "description": "Unique Form View ID" - } - ], - "patch": { - "summary": "Update Form View", - "operationId": "db-view-form-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number" - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FormUpdateReq" - }, - "examples": { - "Example 1": { - "value": { - "banner_image_url": null, - "email": "user@example.com", - "heading": "My Form", - "lock_type": "collaborative", - "logo_url": null, - "meta": null, - "redirect_after_secs": null, - "redirect_url": null, - "show_blank_form": 0, - "subheading": "My Form Subheading", - "submit_another_form": 0, - "success_msg": "Thank you for the submission.", - "title": "Form View 1" - } - } - } - } - } - }, - "description": "Update the form data by Form ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "get": { - "summary": "Get Form", - "operationId": "db-view-form-read", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Form" - }, - "examples": { - "Example 1": { - "value": { - "base_id": "ds_g4ccx6e77h1dmi", - "banner_image_url": null, - "columns": [ - { - "id": "fvc_ugj9zo5bzocxtl", - "base_id": "ds_g4ccx6e77h1dmi", - "project_id": "p_xm3thidrblw4n7", - "fk_view_id": "vw_kdf5cr7qmhksek", - "fk_column_id": "cl_phvuuwjrzcdo0g", - "uuid": null, - "label": null, - "help": null, - "description": null, - "required": null, - "show": 0, - "order": 1, - "created_at": "2023-03-04 16:40:47", - "updated_at": "2023-03-04 16:40:47", - "meta": {} - } - ], - "email": "user@example.com", - "fk_model_id": "md_rsu68aqjsbyqtl", - "heading": "My Form", - "lock_type": "collaborative", - "logo_url": null, - "meta": null, - "redirect_after_secs": null, - "redirect_url": null, - "show_blank_form": 0, - "subheading": "My Form Subheading", - "submit_another_form": 0, - "success_msg": "Thank you for the submission.", - "title": "Form View 1" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "description": "Get the form data by Form ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/form-columns/{formViewColumnId}": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "fvc_1m9b0aub791d4m", - "type": "string" - }, - "name": "formViewColumnId", - "in": "path", - "required": true, - "description": "Unique Form View Column ID" - } - ], - "patch": { - "summary": "Update Form Column", - "operationId": "db-view-form-column-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FormColumnReq" - }, - "examples": { - "Example 1": { - "value": { - "description": null, - "help": "This is a help text", - "label": "Form Label", - "meta": null, - "order": 1, - "required": 0, - "show": 0 - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FormColumnReq" - } - } - } - }, - "description": "Update the form column(s) by Form View Column ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/grids/{viewId}": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "vw_wtdg2meyig5l4q" - }, - "name": "viewId", - "in": "path", - "required": true, - "description": "Unique View ID" - } - ], - "patch": { - "summary": "Update Grid View", - "operationId": "db-view-grid-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number" - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GridUpdateReq" - }, - "examples": { - "Example 1": { - "value": { - "row_height": 1, - "meta": null - } - } - } - } - } - }, - "description": "Update Grid View", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/grids/{gridId}/grid-columns": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "vw_q6k13mmygdi3yz" - }, - "name": "gridId", - "in": "path", - "required": true, - "description": "Grid View ID" - } - ], - "get": { - "summary": "List Grid Columns", - "operationId": "db-view-grid-columns-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GridColumn" - } - }, - "examples": { - "Example 1": { - "value": [ - { - "id": "nc_c8jz4kxe6xvh11", - "fk_view_id": "vw_p2jcatxz4mvcfw", - "fk_column_id": "cl_c5knoi4xs4sfpt", - "project_id": "p_xm3thidrblw4n7", - "base_id": "ds_g4ccx6e77h1dmi", - "show": 0, - "order": 1, - "width": "200px", - "help": null - } - ] - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "description": "List all columns in the given Grid", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/grid-columns/{columnId}": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "cl_8iw2o4ejzvdyna", - "type": "string" - }, - "name": "columnId", - "in": "path", - "required": true, - "description": "Unique Column ID" - } - ], - "patch": { - "summary": "Update Grid Column", - "operationId": "db-view-grid-column-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number" - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GridColumnReq" - }, - "examples": { - "Example 1": { - "value": { - "fk_column_id": "cl_c5knoi4xs4sfpt", - "label": "My Column", - "width": "200px" - } - } - } - } - } - }, - "description": "Update grid column(s) in the given Grid", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/tables/{tableId}/galleries": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "md_w9gpnaousnfss1" - }, - "name": "tableId", - "in": "path", - "required": true, - "description": "Unique Table ID" - } - ], - "post": { - "summary": "Create Gallery View", - "operationId": "db-view-gallery-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/View" - }, - "examples": { - "Example 1": { - "value": { - "id": "vw_qp94qfnvffgk5f", - "base_id": "ds_a95vextjl510z7", - "project_id": "p_slkm6i3v31q4bc", - "fk_model_id": "md_8hr3xndx8umuce", - "title": "Gallery-1", - "type": 2, - "is_default": null, - "show_system_fields": null, - "lock_type": "collaborative", - "uuid": null, - "password": null, - "show": true, - "order": 3, - "created_at": "2023-03-13T07:29:18.707Z", - "updated_at": "2023-03-13T07:29:18.707Z", - "meta": {} - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ViewCreateReq" - }, - "examples": { - "Example 1": { - "value": { - "title": "My Gallery View", - "type": 2, - "copy_from_id": null, - "fk_grp_col_id": null, - "fk_geo_data_col_id": null - } - } - } - } - } - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/galleries/{galleryViewId}": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "vw_1eq2wk2xe3a9j5" - }, - "name": "galleryViewId", - "in": "path", - "required": true, - "description": "Unique Gallery View ID" - } - ], - "patch": { - "summary": "Update Gallery View", - "operationId": "db-view-gallery-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number" - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GalleryUpdateReq" - }, - "examples": { - "Example 1": { - "value": { - "fk_cover_image_col_id": "cl_ib8l4j1kiu1efx", - "meta": null - } - } - } - } - } - }, - "description": "Update the Gallery View data with Gallery ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "get": { - "summary": "Get Gallery View", - "operationId": "db-view-gallery-read", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Gallery" - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "description": "Get the Gallery View data with Gallery ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/tables/{tableId}/kanbans": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "md_w9gpnaousnfss1", - "type": "string" - }, - "name": "tableId", - "in": "path", - "required": true, - "description": "Unique Table ID" - } - ], - "post": { - "summary": "Create Kanban View", - "operationId": "db-view-kanban-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/View" - }, - "examples": { - "Example 1": { - "value": { - "id": "vw_569sqsrp2vuff4", - "base_id": "ds_a95vextjl510z7", - "project_id": "p_slkm6i3v31q4bc", - "fk_model_id": "md_8hr3xndx8umuce", - "title": "Kanban-1", - "type": 4, - "is_default": null, - "show_system_fields": null, - "lock_type": "collaborative", - "uuid": null, - "password": null, - "show": true, - "order": 5, - "created_at": "2023-03-13T07:29:21.387Z", - "updated_at": "2023-03-13T07:29:21.387Z", - "meta": {} - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ViewCreateReq" - }, - "examples": { - "Example 1": { - "value": { - "title": "My Kanban View", - "type": 4, - "copy_from_id": null, - "fk_grp_col_id": "cl_g0a89q9xdry3lu", - "fk_geo_data_col_id": null - } - } - } - } - } - }, - "description": "Create a new Kanban View", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/kanbans/{kanbanViewId}": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "vw_1eq2wk2xe3a9j5" - }, - "name": "kanbanViewId", - "in": "path", - "required": true, - "description": "Unique Kanban View ID" - } - ], - "patch": { - "summary": "Update Kanban View", - "operationId": "db-view-kanban-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number" - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/KanbanUpdateReq" - }, - "examples": { - "Example 1": { - "value": { - "fk_grp_col_id": "cl_g0a89q9xdry3lu", - "fk_cover_image_col_id": "cl_ib8l4j1kiu1efx", - "meta": { - "cl_g0a89q9xdry3lu": [ - { - "id": "uncategorized", - "title": null, - "order": 0, - "color": "#c2f5e8", - "collapsed": false - }, - { - "id": "sl_ihyva6jx6dg0fc", - "fk_column_id": "cl_g0a89q9xdry3lu", - "title": "a", - "color": "#cfdffe", - "order": 1, - "collapsed": false - }, - { - "id": "sl_gqdm5v6t8aetoa", - "fk_column_id": "cl_g0a89q9xdry3lu", - "title": "b", - "color": "#d0f1fd", - "order": 2, - "collapsed": false - }, - { - "id": "sl_eipnl0kn7a9d3c", - "fk_column_id": "cl_g0a89q9xdry3lu", - "title": "cc", - "color": "#c2f5e8", - "order": 3, - "collapsed": false - }, - { - "id": "sl_dei8p2jq0cnlv0", - "fk_column_id": "cl_g0a89q9xdry3lu", - "title": "d", - "color": "#ffdaf6", - "order": 4, - "collapsed": false - } - ] - } - } - } - } - } - } - }, - "description": "Update the Kanban View data with Kanban ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "get": { - "summary": "Get Kanban View", - "operationId": "db-view-kanban-read", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Kanban" - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "description": "Get the Kanban View data by Kanban ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/tables/{tableId}/maps": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "md_w9gpnaousnfss1", - "type": "string" - }, - "name": "tableId", - "in": "path", - "required": true, - "description": "Unique Table ID" - } - ], - "post": { - "summary": "Create Map View", - "operationId": "db-view-map-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/View" - }, - "examples": { - "Example 1": { - "value": { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:46:31", - "fk_model_id": "md_mhs9z4r2ak98x0", - "id": "vw_lg052cnc1c26kf", - "is_default": 1, - "lock_type": "collaborative", - "meta": {}, - "order": 1, - "password": null, - "project_id": "p_xm3thidrblw4n7", - "show": 1, - "show_system_fields": null, - "title": "Sheet-1", - "type": 3, - "updated_at": "2023-03-02 17:46:31", - "uuid": null - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ViewCreateReq" - }, - "examples": { - "Example 1": { - "value": { - "title": "My Map View", - "type": 5, - "copy_from_id": null, - "fk_grp_col_id": null, - "fk_geo_data_col_id": "cl_uu1meolj00tlrq" - } - } - } - } - }, - "description": "" - }, - "description": "Create a new Map View", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/maps/{mapViewId}": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "vw_1eq2wk2xe3a9j5" - }, - "name": "mapViewId", - "in": "path", - "required": true, - "description": "Unique Map View ID" - } - ], - "patch": { - "summary": "Update Map View", - "operationId": "db-view-map-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number" - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/MapUpdateReq" - }, - "examples": { - "Example 1": { - "value": { - "fk_geo_data_col_id": "cl_8iw2o4ejzvdyna", - "meta": null - } - } - } - } - } - }, - "description": "Update the Map View data by Map ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "get": { - "summary": "Get Map View", - "operationId": "db-view-map-read", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Map" - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "description": "Get the Map View data by Map ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/projects/{projectId}/meta-diff": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - } - ], - "post": { - "summary": "Sync Meta", - "operationId": "project-meta-diff-sync", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "la6fd99uw6eao" - }, - "example": "The meta has been synchronized successfully" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "The meta has been synchronized successfully" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Project"], - "description": "Synchronise the meta data difference between NC_DB and external data sources ", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "get": { - "summary": "Meta Diff", - "operationId": "project-meta-diff-get", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["Project"], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "x-stoplight": { - "id": "awdkjwr7uultr" - }, - "type": "object", - "properties": { - "table_name": { - "type": "string", - "x-stoplight": { - "id": "jjj8ufafq1sd2" - }, - "description": "Table Name", - "example": "Table 1" - }, - "base_id": { - "type": "string", - "x-stoplight": { - "id": "smx2or6bv1xym" - }, - "description": "Base ID", - "example": "ds_rrplkgy0pq1f3c" - }, - "type": { - "type": "string", - "x-stoplight": { - "id": "zr19ahh1s6d13" - }, - "description": "Change Type", - "example": "table" - }, - "detectedChanges": { - "type": "array", - "x-stoplight": { - "id": "bptxla2y27aq6" - }, - "description": "Detected Changes", - "items": { - "x-stoplight": { - "id": "ob16o1ln7xy8o" - }, - "type": "object" - } - } - } - } - }, - "examples": { - "Example 1": { - "value": [ - { - "table_name": "_nc_m2m_uuv_xzru3m", - "base_id": "ds_rrplkgy0pq1f3c", - "type": "table", - "detectedChanges": [ - { - "type": "TABLE_NEW", - "msg": "New table" - }, - { - "type": "TABLE_RELATION_ADD", - "tn": "_nc_m2m_uuv_xzru3m", - "rtn": "Sheet-1", - "cn": "table1_id", - "rcn": "id", - "msg": "New relation added", - "relationType": "bt", - "cstn": "_nc_m2m_uuv_xzru3m_table1_id_foreign" - }, - { - "type": "TABLE_RELATION_ADD", - "tn": "_nc_m2m_uuv_xzru3m", - "rtn": "address", - "cn": "table2_id", - "rcn": "address_id", - "msg": "New relation added", - "relationType": "bt", - "cstn": "_nc_m2m_uuv_xzru3m_table2_id_foreign" - } - ] - } - ] - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Get the meta data difference between NC_DB and external data sources " - } - }, - "/api/v1/db/meta/projects/{projectId}/meta-diff/{baseId}": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - }, - { - "schema": { - "type": "string", - "pattern": "ds_j04jmxh5xg10lu" - }, - "name": "baseId", - "in": "path", - "required": true, - "description": "Unique Base ID" - } - ], - "post": { - "summary": "Synchronise Base Meta", - "operationId": "base-meta-diff-sync", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "acy7tx4rounqw" - }, - "example": "The base meta has been synchronized successfully" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "The base meta has been synchronized successfully" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Base"], - "description": "Synchronise the meta data difference between NC_DB and external data sources in a given Base", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "get": { - "summary": "Base Meta Diff", - "operationId": "base-meta-diff-get", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["Base"], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "x-stoplight": { - "id": "pav4jmel1ebeu" - }, - "type": "object", - "properties": { - "table_name": { - "type": "string", - "x-stoplight": { - "id": "xjw4k4httzmaf" - }, - "description": "Table Name", - "example": "Table 1" - }, - "base_id": { - "type": "string", - "x-stoplight": { - "id": "l1o3qhkgagsdl" - }, - "example": "ds_rrplkgy0pq1f3c", - "description": "Base ID" - }, - "type": { - "type": "string", - "x-stoplight": { - "id": "v5ciaygrj64uh" - }, - "description": "Change Type", - "example": "table" - }, - "detectedChanges": { - "type": "array", - "x-stoplight": { - "id": "wqn5noi0e46q8" - }, - "description": "Detected Changes", - "items": { - "x-stoplight": { - "id": "r2roo274wquvf" - }, - "type": "object" - } - } - } - } - }, - "examples": { - "Example 1": { - "value": [ - { - "table_name": "_nc_m2m_uuv_xzru3m", - "base_id": "ds_rrplkgy0pq1f3c", - "type": "table", - "detectedChanges": [ - { - "type": "TABLE_NEW", - "msg": "New table" - }, - { - "type": "TABLE_RELATION_ADD", - "tn": "_nc_m2m_uuv_xzru3m", - "rtn": "Sheet-1", - "cn": "table1_id", - "rcn": "id", - "msg": "New relation added", - "relationType": "bt", - "cstn": "_nc_m2m_uuv_xzru3m_table1_id_foreign" - }, - { - "type": "TABLE_RELATION_ADD", - "tn": "_nc_m2m_uuv_xzru3m", - "rtn": "address", - "cn": "table2_id", - "rcn": "address_id", - "msg": "New relation added", - "relationType": "bt", - "cstn": "_nc_m2m_uuv_xzru3m_table2_id_foreign" - } - ] - } - ] - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Get the meta data difference between NC_DB and external data sources in a given Base" - } - }, - "/api/v1/db/meta/projects/{projectId}/has-empty-or-null-filters": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - } - ], - "get": { - "summary": "List Empty & Null Filter", - "operationId": "project-has-empty-or-null-filters", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["Project"], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": {} - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Check if a project contains empty and null filters. Used in `Show NULL and EMPTY in Filter` in Project Setting.", - "x-internal": true - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - } - ], - "get": { - "summary": "List Table Rows", - "operationId": "db-table-row-list", - "description": "List all table rows in a given table and project", - "tags": ["DB Table Row"], - "parameters": [ - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "fields", - "description": "Which fields to be shown" - }, - { - "schema": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "type": "string" - } - ] - }, - "in": "query", - "name": "sort", - "description": "The result will be sorted based on `sort` query" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where", - "description": "Extra filtering" - }, - { - "schema": { - "type": "integer", - "minimum": 0 - }, - "in": "query", - "name": "offset", - "description": "Offset in rows" - }, - { - "schema": { - "type": "integer", - "minimum": 1 - }, - "in": "query", - "name": "limit", - "description": "Limit in rows" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "sortArrJson", - "description": "Used for multiple sort queries" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "filterArrJson", - "description": "Used for multiple filter queries" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "list": { - "type": "array", - "x-stoplight": { - "id": "g92aqxk869a7o" - }, - "description": "List of data objects", - "items": { - "x-stoplight": { - "id": "rnbt8ubciknfd" - }, - "type": "object" - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated", - "x-stoplight": { - "id": "7f38yyzdg03x5" - }, - "description": "Paginated Info" - } - }, - "required": ["list", "pageInfo"] - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "Id": 1, - "Title": "baz", - "SingleSelect": null, - "Sheet-1 List": [ - { - "Id": 1, - "Title": "baz" - } - ], - "LTAR": [ - { - "Id": 1, - "Title": "baz" - } - ] - }, - { - "Id": 2, - "Title": "foo", - "SingleSelect": "a", - "Sheet-1 List": [ - { - "Id": 2, - "Title": "foo" - } - ], - "LTAR": [ - { - "Id": 2, - "Title": "foo" - } - ] - }, - { - "Id": 3, - "Title": "bar", - "SingleSelect": "b", - "Sheet-1 List": [], - "LTAR": [] - } - ], - "pageInfo": { - "totalRows": 3, - "page": 1, - "pageSize": 25, - "isFirstPage": true, - "isLastPage": true - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - } - }, - "post": { - "summary": "Create Table Row", - "operationId": "db-table-row-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": {} - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Row"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "examples": { - "Example 1": { - "value": { - "Id": 1, - "Title": "foo", - "CreatedAt": "2023-03-11T09:10:53.567Z", - "UpdatedAt": "2023-03-11T09:10:53.567Z" - } - } - } - } - } - }, - "description": "Create a new row in a given table and project.", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/find-one": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - } - ], - "get": { - "summary": "Find One Table Row", - "operationId": "db-table-row-find-one", - "description": "Return the first result of the target Table Row", - "tags": ["DB Table Row"], - "parameters": [ - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "fields" - }, - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "sort" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "examples": { - "Example 1": { - "value": { - "Id": 1, - "Title": "foo", - "CreatedAt": "2023-03-11T09:10:53.567Z", - "UpdatedAt": "2023-03-11T09:10:53.567Z" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - } - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/groupby": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "column_name", - "description": "Column name of the column you want to group by, eg. `column_name=column1`" - } - ], - "get": { - "summary": "Group By Table Row", - "operationId": "db-table-row-group-by", - "description": "Get the result grouped by the given query", - "tags": ["DB Table Row"], - "parameters": [ - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "sort" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where" - }, - { - "schema": { - "type": "integer", - "minimum": 1 - }, - "in": "query", - "name": "limit" - }, - { - "schema": { - "type": "integer", - "minimum": 0 - }, - "in": "query", - "name": "offset" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": {} - } - } - } - } - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/views/{viewName}/group/{columnId}": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string", - "example": "p_tbhl1hnycvhe5l" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string", - "example": "md_5hua2iqloqirhd" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "type": "string", - "example": "vw_mldv0a5mtwh1la" - }, - "name": "viewName", - "in": "path", - "required": true, - "description": "View Name" - }, - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "cl_8iw2o4ejzvdyna", - "type": "string" - }, - "name": "columnId", - "in": "path", - "required": true, - "description": "Unique Column ID" - } - ], - "get": { - "summary": "Table Group by Column", - "operationId": "db-view-row-grouped-data-list", - "description": "Get the grouped data By Column ID. Used in Kanban View.", - "tags": ["DB View Row"], - "parameters": [ - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "fields" - }, - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "sort" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where" - }, - { - "schema": {}, - "in": "query", - "name": "nested", - "description": "Query params for nested data" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": {} - }, - "examples": { - "Example 1": { - "value": [ - { - "key": "a", - "value": { - "list": [ - { - "Id": 2, - "Title": "foo", - "SingleSelect": "a" - } - ], - "pageInfo": { - "totalRows": 1, - "page": 1, - "pageSize": 25, - "isFirstPage": true, - "isLastPage": true - } - } - }, - { - "key": "b", - "value": { - "list": [ - { - "Id": 3, - "Title": "bar", - "SingleSelect": "b" - } - ], - "pageInfo": { - "totalRows": 1, - "page": 1, - "pageSize": 25, - "isFirstPage": true, - "isLastPage": true - } - } - }, - { - "key": null, - "value": { - "list": [ - { - "Id": 1, - "Title": "baz", - "SingleSelect": null - }, - { - "Id": 5, - "Title": "xyz", - "SingleSelect": null - } - ], - "pageInfo": { - "totalRows": 2, - "page": 1, - "pageSize": 25, - "isFirstPage": true, - "isLastPage": true - } - } - } - ] - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - } - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/group/{columnId}": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string", - "example": "p_tbhl1hnycvhe5l" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string", - "example": "md_5hua2iqloqirhd" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "cl_8iw2o4ejzvdyna", - "type": "string" - }, - "name": "columnId", - "in": "path", - "required": true, - "description": "Unique Column ID" - } - ], - "get": { - "summary": "Table Group by Column", - "operationId": "db-table-row-grouped-data-list", - "description": "Get the grouped data By Column ID. Used in Kanban View.", - "tags": ["DB Table Row"], - "parameters": [ - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "fields" - }, - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "sort" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where" - }, - { - "schema": {}, - "in": "query", - "name": "nested", - "description": "Query params for nested data" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": {} - }, - "examples": { - "Example 1": { - "value": [ - { - "key": "a", - "value": { - "list": [ - { - "Id": 2, - "Title": "foo", - "SingleSelect": "a" - } - ], - "pageInfo": { - "totalRows": 1, - "page": 1, - "pageSize": 25, - "isFirstPage": true, - "isLastPage": true - } - } - }, - { - "key": "b", - "value": { - "list": [ - { - "Id": 3, - "Title": "bar", - "SingleSelect": "b" - } - ], - "pageInfo": { - "totalRows": 1, - "page": 1, - "pageSize": 25, - "isFirstPage": true, - "isLastPage": true - } - } - }, - { - "key": null, - "value": { - "list": [ - { - "Id": 1, - "Title": "baz", - "SingleSelect": null - }, - { - "Id": 5, - "Title": "xyz", - "SingleSelect": null - } - ], - "pageInfo": { - "totalRows": 2, - "page": 1, - "pageSize": 25, - "isFirstPage": true, - "isLastPage": true - } - } - } - ] - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - } - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/views/{viewName}": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "type": "string" - }, - "name": "viewName", - "in": "path", - "required": true - } - ], - "get": { - "summary": "List Table View Rows", - "operationId": "db-view-row-list", - "description": "List all table view rows", - "tags": ["DB View Row"], - "parameters": [ - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "fields" - }, - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "sort" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where" - }, - { - "schema": {}, - "in": "query", - "name": "nested", - "description": "Query params for nested data" - }, - { - "schema": { - "type": "number" - }, - "in": "query", - "name": "offset" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "list": { - "type": "array", - "x-stoplight": { - "id": "okd8utzm9xqet" - }, - "description": "List of table view rows", - "items": { - "x-stoplight": { - "id": "j758lsjv53o4q" - }, - "type": "object" - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated", - "x-stoplight": { - "id": "hylgqzgm8yhye" - }, - "description": "Paginated Info" - } - }, - "required": ["list", "pageInfo"] - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "Id": 1, - "Title": "baz", - "SingleSelect": null, - "Sheet-1 List": [ - { - "Id": 1, - "Title": "baz" - } - ], - "LTAR": [ - { - "Id": 1, - "Title": "baz" - } - ] - }, - { - "Id": 2, - "Title": "foo", - "SingleSelect": "a", - "Sheet-1 List": [ - { - "Id": 2, - "Title": "foo" - } - ], - "LTAR": [ - { - "Id": 2, - "Title": "foo" - } - ] - }, - { - "Id": 3, - "Title": "bar", - "SingleSelect": "b", - "Sheet-1 List": [], - "LTAR": [] - } - ], - "pageInfo": { - "totalRows": 3, - "page": 1, - "pageSize": 25, - "isFirstPage": true, - "isLastPage": true - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - } - }, - "post": { - "summary": "Create Table View Row", - "operationId": "db-view-row-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "examples": { - "Example 1": { - "value": { - "Id": 1, - "col1": "foo", - "col2": "bar", - "CreatedAt": "2023-03-11T08:48:25.598Z", - "UpdatedAt": "2023-03-11T08:48:25.598Z" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View Row"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "examples": { - "Example 1": { - "value": { - "col1": "foo", - "col2": "bar" - } - } - } - } - } - }, - "description": "Create a new row in the given Table View" - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/views/{viewName}/find-one": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "type": "string" - }, - "name": "viewName", - "in": "path", - "required": true - } - ], - "get": { - "summary": "Find One Table View Row", - "operationId": "db-view-row-find-one", - "description": "Return the first result of table view rows with the given query", - "tags": ["DB View Row"], - "parameters": [ - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "fields" - }, - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "sort" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where" - }, - { - "schema": {}, - "in": "query", - "name": "nested", - "description": "Query params for nested data" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "examples": { - "Example 1": { - "value": { - "Id": 1, - "Title": "foo", - "CreatedAt": "2023-03-11T09:10:53.567Z", - "UpdatedAt": "2023-03-11T09:10:53.567Z" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - } - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/views/{viewName}/groupby": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "type": "string" - }, - "name": "viewName", - "in": "path", - "required": true - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "column_name", - "description": "Column name of the column you want to group by, eg. `column_name=column1`" - } - ], - "get": { - "summary": "Group By Table View Row", - "operationId": "db-view-row-group-by", - "description": "Get the table view rows groupe by the given query", - "tags": ["DB View Row"], - "parameters": [ - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "sort" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where" - }, - { - "schema": { - "type": "integer", - "minimum": 1 - }, - "in": "query", - "name": "limit" - }, - { - "schema": { - "type": "integer", - "minimum": 0 - }, - "in": "query", - "name": "offset" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": {} - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - } - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/views/{viewName}/count": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "type": "string", - "example": "vw_75neroyqdye94k" - }, - "name": "viewName", - "in": "path", - "required": true, - "description": "View Name" - } - ], - "get": { - "summary": "Count Table View Rows", - "operationId": "db-view-row-count", - "description": "Count how many rows in the given Table View", - "tags": ["DB View Row"], - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where" - }, - { - "schema": {}, - "in": "query", - "name": "nested", - "description": "Query params for nested data" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "count": { - "type": "number", - "x-stoplight": { - "id": "hwq29x70rcipi" - } - } - } - }, - "examples": { - "Example 1": { - "value": { - "count": 25 - } - } - } - } - } - } - } - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/views/{viewName}/{rowId}": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "type": "string", - "example": "vw_75neroyqdye94k" - }, - "name": "viewName", - "in": "path", - "required": true, - "description": "View Name" - }, - { - "schema": { - "example": "1" - }, - "name": "rowId", - "in": "path", - "required": true, - "description": "Unique Row ID" - } - ], - "get": { - "summary": "Get Table View Row", - "operationId": "db-view-row-read", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {} - }, - "examples": { - "Example 1": { - "value": { - "Id": 1, - "Title": "foo", - "CreatedAt": "2023-03-11T09:11:47.437Z", - "UpdatedAt": "2023-03-11T09:11:47.784Z" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Get the target Table View Row", - "tags": ["DB View Row"], - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "patch": { - "summary": "Update Table View Row", - "operationId": "db-view-row-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "examples": { - "Example 1": { - "value": { - "Id": 1, - "Title": "bar", - "CreatedAt": "2023-03-11T09:11:47.437Z", - "UpdatedAt": "2023-03-11T09:20:21.133Z" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View Row"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "examples": { - "Example 1": { - "value": { - "Title": "bar" - } - } - } - } - } - }, - "description": "Update the target Table View Row", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "delete": { - "summary": "Delete Table View Row", - "operationId": "db-view-row-delete", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number" - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View Row"], - "description": "Delete the target Table View Row", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/views/{viewName}/{rowId}/exist": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "type": "string" - }, - "name": "viewName", - "in": "path", - "required": true - }, - { - "schema": { - "example": "1" - }, - "name": "rowId", - "in": "path", - "required": true, - "description": "Unique Row ID" - } - ], - "get": { - "summary": "Does Table View Row Exist", - "operationId": "db-view-row-exist", - "responses": { - "201": { - "description": "Created", - "content": { - "application/json": { - "schema": { - "type": "number" - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Check row with provided primary key exists or not", - "tags": ["DB View Row"], - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/{rowId}": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "example": "1" - }, - "name": "rowId", - "in": "path", - "required": true, - "description": "Unique Row ID" - } - ], - "get": { - "summary": "Get Table Row", - "operationId": "db-table-row-read", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {} - }, - "examples": { - "Example 1": { - "value": { - "Id": 1, - "Title": "foo", - "CreatedAt": "2023-03-11T09:11:47.437Z", - "UpdatedAt": "2023-03-11T09:11:47.784Z" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Get the Table Row by Row ID", - "tags": ["DB Table Row"], - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "patch": { - "summary": "Update Table Row", - "operationId": "db-table-row-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "examples": { - "Example 1": { - "value": { - "Id": 1, - "Title": "bar", - "CreatedAt": "2023-03-11T09:11:47.437Z", - "UpdatedAt": "2023-03-11T09:20:21.133Z" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Row"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "examples": { - "Example 1": { - "value": { - "Title": "bar" - } - } - } - } - } - }, - "description": "Update the Table Row", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "delete": { - "summary": "Delete Table Row", - "operationId": "db-table-row-delete", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number" - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Row"], - "description": "Delete the Table Row", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/{rowId}/exist": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "example": "1" - }, - "name": "rowId", - "in": "path", - "required": true, - "description": "Unique Row ID" - } - ], - "get": { - "summary": "Does Table Row Exist", - "operationId": "db-table-row-exist", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number" - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "check row with provided primary key exists or not", - "tags": ["DB Table Row"], - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/data/bulk/{orgs}/{projectName}/{tableName}": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - } - ], - "post": { - "summary": "Bulk Insert Table Rows", - "operationId": "db-table-row-bulk-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "description": "List of returned IDs", - "items": { - "x-stoplight": { - "id": "dbkhyd3mnajax" - }, - "type": "object", - "properties": { - "id": { - "type": "string", - "x-stoplight": { - "id": "lnwqjl14f287f" - } - } - } - } - }, - "examples": { - "Example 1": { - "value": [ - { - "id": 1 - }, - { - "id": 2 - } - ] - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Row"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "array", - "description": "List of data objects", - "items": { - "x-stoplight": { - "id": "7u0mp8nzlvysz" - }, - "type": "object" - } - }, - "examples": { - "Example 1": { - "value": [ - { - "Title": "abc" - }, - { - "Title": "def" - } - ] - } - } - } - }, - "description": "" - }, - "description": "Bulk insert table rows in one go.", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "patch": { - "summary": "Bulk Update Table Rows by IDs", - "operationId": "db-table-row-bulk-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "description": "List of returned values. 1 means successful. 0 means failed.", - "items": { - "x-stoplight": { - "id": "ga0xhsahovdt7" - }, - "type": "number" - } - }, - "examples": { - "Example 1": { - "value": [1, 1] - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Row"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "array", - "description": "List of data objects", - "items": { - "x-stoplight": { - "id": "q2xtbf29i1s5n" - }, - "type": "object" - } - }, - "examples": { - "Example 1": { - "value": [ - { - "Id": "1", - "Title": "123" - }, - { - "Id": "2", - "Title": "456" - } - ] - } - } - } - } - }, - "description": "Bulk Update Table Rows by given IDs", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "delete": { - "summary": "Bulk Delete Table Rows by IDs", - "operationId": "db-table-row-bulk-delete", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "x-stoplight": { - "id": "b9o9o2r6ipho9" - }, - "type": "number" - } - }, - "examples": { - "Example 1": { - "value": [1, 1] - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Row"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "x-stoplight": { - "id": "sd8udhhjnqiay" - }, - "type": "object" - } - }, - "examples": { - "Example 1": { - "value": [ - { - "Id": "1" - }, - { - "Id": "2" - } - ] - } - } - } - }, - "description": "" - }, - "description": "Bulk Delete Table Rows by given IDs", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/data/bulk/{orgs}/{projectName}/{tableName}/all": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where" - } - ], - "patch": { - "summary": "Bulk Update Table Rows with Conditions", - "operationId": "db-table-row-bulk-update-all", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": {}, - "examples": { - "Example 1": { - "value": [ - { - "Id": "1" - }, - { - "Id": "2" - } - ] - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Row"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "examples": { - "Example 1": { - "value": { - "Title": "foo" - } - } - } - } - } - }, - "description": "Bulk Update all Table Rows if the condition is true", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "delete": { - "summary": "Bulk Delete Table Rows with Conditions", - "operationId": "db-table-row-bulk-delete-all", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "x-stoplight": { - "id": "9gcl3ok7is3y0" - }, - "type": "object" - } - }, - "examples": { - "Example 1": { - "value": [1, 1] - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Row"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "examples": { - "Example 1": { - "value": { - "Title": "foo" - } - } - } - } - } - }, - "description": "Bulk Delete all Table Rows if the condition is true", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/views/{viewName}/export/{type}": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "type": "string" - }, - "name": "viewName", - "in": "path", - "required": true - }, - { - "schema": { - "type": "string", - "enum": ["csv", "excel"] - }, - "name": "type", - "in": "path", - "required": true - } - ], - "get": { - "summary": "Export Table View Rows", - "operationId": "db-view-row-export", - "description": "Export Table View Rows by CSV or Excel", - "tags": ["DB View Row"], - "wrapped": true, - "responses": { - "200": { - "description": "OK", - "content": { - "application/octet-stream": { - "schema": {} - } - }, - "headers": { - "nc-export-offset": { - "schema": { - "type": "integer" - }, - "description": "The starting offset of the next set of rows" - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/export/{type}": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "type": "string", - "enum": ["csv", "excel"] - }, - "name": "type", - "in": "path", - "required": true - } - ], - "get": { - "summary": "Export Table View Rows", - "operationId": "db-table-row-csv-export", - "description": "Export Table View Rows by CSV or Excel", - "tags": ["DB Table Row"], - "wrapped": true, - "responses": { - "200": { - "description": "OK", - "content": { - "application/octet-stream": { - "schema": {} - } - }, - "headers": { - "nc-export-offset": { - "schema": { - "type": "integer" - }, - "description": "The starting offset of the next set of rows" - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/{rowId}/{relationType}/{columnName}": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "example": "1" - }, - "name": "rowId", - "in": "path", - "required": true, - "description": "Unique Row ID" - }, - { - "schema": { - "type": "string", - "enum": ["mm", "hm", "bt"] - }, - "name": "relationType", - "in": "path", - "required": true, - "description": "Relation Type" - }, - { - "schema": { - "type": "string" - }, - "name": "columnName", - "in": "path", - "required": true, - "description": "Column Name" - } - ], - "get": { - "summary": "List Nested Relations Rows", - "operationId": "db-table-row-nested-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": {} - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Row"], - "parameters": [ - { - "schema": { - "type": "integer", - "minimum": 1 - }, - "in": "query", - "name": "limit" - }, - { - "schema": { - "type": "integer", - "minimum": 0 - }, - "in": "query", - "name": "offset" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "description": "List all nested relations rows" - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/{rowId}/{relationType}/{columnName}/{refRowId}": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "example": "1" - }, - "name": "rowId", - "in": "path", - "required": true, - "description": "Unique Row ID" - }, - { - "schema": { - "type": "string", - "enum": ["mm", "hm", "bt"] - }, - "name": "relationType", - "in": "path", - "required": true - }, - { - "schema": { - "type": "string" - }, - "name": "columnName", - "in": "path", - "required": true - }, - { - "schema": { - "type": "string" - }, - "name": "refRowId", - "in": "path", - "required": true - } - ], - "post": { - "summary": "Create Nested Relations Row", - "operationId": "db-table-row-nested-add", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "m6jox00hxgd6s" - }, - "example": "The relation data has been created successfully" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "The relation data has been created successfully" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Row"], - "parameters": [ - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "fields", - "description": "Which fields to be shown" - }, - { - "schema": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "type": "string" - } - ] - }, - "in": "query", - "name": "sort", - "description": "The result will be sorted based on `sort` query" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where", - "description": "Extra filtering" - }, - { - "schema": { - "type": "integer", - "minimum": 0 - }, - "in": "query", - "name": "offset", - "description": "Offset in rows" - }, - { - "schema": { - "type": "integer", - "minimum": 1 - }, - "in": "query", - "name": "limit", - "description": "Limit in rows" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "sortArrJson", - "description": "Used for multiple sort queries" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "filterArrJson", - "description": "Used for multiple filter queries" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "description": "Create a new nested relations row" - }, - "delete": { - "summary": "Delete Nested Relations Row", - "operationId": "db-table-row-nested-remove", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "vo3x8xf3j2xlb" - }, - "example": "The relation data has been deleted successfully" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "The relation data has been deleted successfully" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Row"], - "description": "Delete a new nested relations row", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/{rowId}/{relationType}/{columnName}/exclude": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "example": "1" - }, - "name": "rowId", - "in": "path", - "required": true, - "description": "Unique Row ID" - }, - { - "schema": { - "type": "string", - "enum": ["mm", "hm", "bt"] - }, - "name": "relationType", - "in": "path", - "required": true - }, - { - "schema": { - "type": "string" - }, - "name": "columnName", - "in": "path", - "required": true - } - ], - "get": { - "summary": "Referenced Table Rows Excluding Current Record's Children / Parent", - "operationId": "db-table-row-nested-children-excluded-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": {} - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Row"], - "parameters": [ - { - "schema": { - "type": "integer", - "minimum": 1 - }, - "in": "query", - "name": "limit" - }, - { - "schema": { - "type": "integer", - "minimum": 0 - }, - "in": "query", - "name": "offset" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "description": "Get the table rows but exculding the current record's children and parent" - } - }, - "/api/v1/db/public/shared-view/{sharedViewUuid}/group/{columnId}": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "24a6d0bb-e45d-4b1a-bfef-f492d870de9f" - }, - "name": "sharedViewUuid", - "in": "path", - "required": true, - "description": "Shared View UUID" - }, - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "cl_8iw2o4ejzvdyna", - "type": "string" - }, - "name": "columnId", - "in": "path", - "required": true, - "description": "Unique Column ID" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "xc-password", - "description": "Shared view password" - } - ], - "get": { - "summary": "List Shared View Grouped Data", - "operationId": "public-grouped-data-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "x-stoplight": { - "id": "bldcv1pwuri5s" - }, - "type": "object", - "properties": { - "key": { - "type": "string", - "x-stoplight": { - "id": "n0ujmkbyhgsxo" - }, - "description": "The Grouped Key" - }, - "value": { - "type": "object", - "x-stoplight": { - "id": "0xsi3jvwn7duo" - }, - "description": "the paginated result of the given key", - "required": ["list", "pageInfo"], - "properties": { - "list": { - "type": "array", - "x-stoplight": { - "id": "jw8dmo16txbjv" - }, - "description": "List of the target data", - "items": { - "x-stoplight": { - "id": "xcu8vxmf5ygyi" - }, - "type": "object" - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated", - "x-stoplight": { - "id": "1gsbgwi9bg8s5" - }, - "description": "Paginated Info" - } - } - } - }, - "required": ["key", "value"] - } - }, - "examples": { - "Example 1": { - "value": [ - { - "key": "a", - "value": { - "list": [ - { - "Id": 2, - "Title": "foo", - "s": "a" - } - ], - "pageInfo": { - "totalRows": 1, - "page": 1, - "pageSize": 25, - "isFirstPage": true, - "isLastPage": true - } - } - }, - { - "key": "b", - "value": { - "list": [ - { - "Id": 3, - "Title": "bar", - "s": "b" - } - ], - "pageInfo": { - "totalRows": 1, - "page": 1, - "pageSize": 25, - "isFirstPage": true, - "isLastPage": true - } - } - }, - { - "key": null, - "value": { - "list": [ - { - "Id": 1, - "Title": "baz", - "s": null - } - ], - "pageInfo": { - "totalRows": 1, - "page": 1, - "pageSize": 25, - "isFirstPage": true, - "isLastPage": true - } - } - } - ] - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Public"], - "parameters": [ - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "fields", - "description": "Which fields to be shown" - }, - { - "schema": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "type": "string" - } - ] - }, - "in": "query", - "name": "sort", - "description": "The result will be sorted based on `sort` query" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where", - "description": "Extra filtering" - }, - { - "schema": { - "type": "integer", - "minimum": 0 - }, - "in": "query", - "name": "offset", - "description": "Offset in rows" - }, - { - "schema": { - "type": "integer", - "minimum": 1 - }, - "in": "query", - "name": "limit", - "description": "Limit in rows" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "sortArrJson", - "description": "Used for multiple sort queries" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "filterArrJson", - "description": "Used for multiple filter queries" - } - ], - "description": "List Shared View Grouped Data" - } - }, - "/api/v1/db/public/shared-view/{sharedViewUuid}/rows": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "24a6d0bb-e45d-4b1a-bfef-f492d870de9f" - }, - "name": "sharedViewUuid", - "in": "path", - "required": true, - "description": "Shared View UUID" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "xc-password", - "description": "Shared view password" - } - ], - "get": { - "summary": "List Shared View Rows", - "operationId": "public-data-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SharedViewList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:46:31", - "fk_model_id": "md_mhs9z4r2ak98x0", - "id": "vw_lg052cnc1c26kf", - "is_default": 1, - "lock_type": "collaborative", - "meta": {}, - "order": 1, - "password": null, - "project_id": "p_xm3thidrblw4n7", - "show": 1, - "show_system_fields": null, - "title": "Sheet-1", - "type": 3, - "updated_at": "2023-03-02 17:46:31", - "uuid": null, - "view": { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:46:31", - "fk_view_id": "vw_lg052cnc1c26kf", - "meta": null, - "project_id": "p_xm3thidrblw4n7", - "row_height": null, - "updated_at": "2023-03-02 17:46:31", - "uuid": null - } - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Public"], - "parameters": [ - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "fields", - "description": "Which fields to be shown" - }, - { - "schema": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "type": "string" - } - ] - }, - "in": "query", - "name": "sort", - "description": "The result will be sorted based on `sort` query" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where", - "description": "Extra filtering" - }, - { - "schema": { - "type": "integer", - "minimum": 0 - }, - "in": "query", - "name": "offset", - "description": "Offset in rows" - }, - { - "schema": { - "type": "integer", - "minimum": 1 - }, - "in": "query", - "name": "limit", - "description": "Limit in rows" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "sortArrJson", - "description": "Used for multiple sort queries" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "filterArrJson", - "description": "Used for multiple filter queries" - } - ], - "description": "List all shared view rows" - }, - "post": { - "summary": "Create Share View Row", - "operationId": "public-data-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "examples": { - "Example 1": { - "value": { - "Id": 1, - "col1": "foo", - "col2": "bar", - "CreatedAt": "2023-03-11T08:48:25.598Z", - "UpdatedAt": "2023-03-11T08:48:25.598Z" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "multipart/form-data": {} - }, - "description": "" - }, - "tags": ["Public"], - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "xc-password", - "description": "Shared view password" - } - ], - "description": "Create a new row for the target shared view" - } - }, - "/api/v1/db/public/shared-view/{sharedViewUuid}/rows/{rowId}/{relationType}/{columnName}": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "24a6d0bb-e45d-4b1a-bfef-f492d870de9f" - }, - "name": "sharedViewUuid", - "in": "path", - "required": true, - "description": "Shared View UUID" - }, - { - "schema": { - "example": "1" - }, - "name": "rowId", - "in": "path", - "required": true, - "description": "Unique Row ID" - }, - { - "schema": { - "type": "string", - "enum": ["mm", "hm", "bt"] - }, - "name": "relationType", - "in": "path", - "required": true, - "description": "Relation Type" - }, - { - "schema": { - "type": "string" - }, - "name": "columnName", - "in": "path", - "required": true, - "description": "Column Name" - } - ], - "get": { - "summary": "List Nested List Data", - "operationId": "public-data-nested-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "list": { - "type": "array", - "x-stoplight": { - "id": "gvblksjzjfyg7" - }, - "description": "List of data objects", - "items": { - "x-stoplight": { - "id": "8assgoc1vtcs9" - }, - "type": "object" - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated", - "x-stoplight": { - "id": "if546w1yuo6fw" - }, - "description": "Paginated info" - } - }, - "required": ["list", "pageInfo"] - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "Id": 1, - "Title": "foo", - "CreatedAt": "2023-03-11T08:41:41.356Z", - "UpdatedAt": "2023-03-11T08:41:41.356Z" - }, - { - "Id": 2, - "Title": "bar", - "CreatedAt": "2023-03-11T08:41:45.330Z", - "UpdatedAt": "2023-03-11T08:41:45.330Z" - }, - { - "Id": 3, - "Title": "baz", - "CreatedAt": "2023-03-11T08:48:25.598Z", - "UpdatedAt": "2023-03-11T08:48:25.598Z" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "pageSize": 1, - "sort": "string", - "totalRows": 3 - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Public"], - "parameters": [ - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "fields", - "description": "Which fields to be shown" - }, - { - "schema": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "type": "string" - } - ] - }, - "in": "query", - "name": "sort", - "description": "The result will be sorted based on `sort` query" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where", - "description": "Extra filtering" - }, - { - "schema": { - "type": "integer", - "minimum": 0 - }, - "in": "query", - "name": "offset", - "description": "Offset in rows" - }, - { - "schema": { - "type": "integer", - "minimum": 1 - }, - "in": "query", - "name": "limit", - "description": "Limit in rows" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "sortArrJson", - "description": "Used for multiple sort queries" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "filterArrJson", - "description": "Used for multiple filter queries" - } - ], - "description": "List all nested list data in a given shared view" - } - }, - "/api/v1/db/public/shared-view/{sharedViewUuid}/rows/export/{type}": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "76d44b86-bc65-4500-8956-ab512c80ab25" - }, - "name": "sharedViewUuid", - "in": "path", - "required": true, - "description": "Shared View UUID" - }, - { - "schema": { - "type": "string", - "enum": ["csv", "excel"], - "example": "csv" - }, - "name": "type", - "in": "path", - "required": true, - "description": "Export Type" - } - ], - "get": { - "summary": "Export Rows in Share View", - "operationId": "public-csv-export", - "description": "Export all rows in Share View in a CSV / Excel Format", - "wrapped": true, - "responses": { - "200": { - "description": "OK", - "content": { - "application/octet-stream": { - "schema": {} - } - }, - "headers": { - "nc-export-offset": { - "schema": { - "type": "integer" - }, - "description": "The starting offset of the next set of rows" - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Public"] - } - }, - "/api/v1/db/public/shared-view/{sharedViewUuid}/nested/{columnName}": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "24a6d0bb-e45d-4b1a-bfef-f492d870de9f" - }, - "name": "sharedViewUuid", - "in": "path", - "required": true, - "description": "Shared View UUID" - }, - { - "schema": { - "type": "string" - }, - "name": "columnName", - "in": "path", - "required": true, - "description": "Column Name" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "xc-password", - "description": "Shared view password" - } - ], - "get": { - "summary": "List Nested Data Relation", - "operationId": "public-data-relation-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": {} - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "parameters": [ - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "fields", - "description": "Which fields to be shown" - }, - { - "schema": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "type": "string" - } - ] - }, - "in": "query", - "name": "sort", - "description": "The result will be sorted based on `sort` query" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where", - "description": "Extra filtering" - }, - { - "schema": { - "type": "integer", - "minimum": 0 - }, - "in": "query", - "name": "offset", - "description": "Offset in rows" - }, - { - "schema": { - "type": "integer", - "minimum": 1 - }, - "in": "query", - "name": "limit", - "description": "Limit in rows" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "sortArrJson", - "description": "Used for multiple sort queries" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "filterArrJson", - "description": "Used for multiple filter queries" - } - ], - "tags": ["Public"], - "description": "List Nested Data Relation" - } - }, - "/api/v1/db/public/shared-base/{sharedBaseUuid}/meta": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "24a6d0bb-e45d-4b1a-bfef-f492d870de9f" - }, - "name": "sharedBaseUuid", - "in": "path", - "required": true, - "description": "Shared Base UUID" - } - ], - "get": { - "summary": "Get Share Base Meta", - "operationId": "public-shared-base-get", - "description": "Get Share Base Meta", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "project_id": { - "type": "string", - "description": "Project ID" - } - } - }, - "examples": { - "Example 1": { - "value": { - "project_id": "p_63b4q0qengen1x" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Public"] - } - }, - "/api/v1/db/public/shared-view/{sharedViewUuid}/meta": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "24a6d0bb-e45d-4b1a-bfef-f492d870de9f" - }, - "name": "sharedViewUuid", - "in": "path", - "required": true, - "description": "Shared View UUID" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "xc-password", - "description": "Shared view password" - } - ], - "get": { - "summary": "Get Share View Meta", - "operationId": "public-shared-view-meta-get", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/View" - }, - { - "type": "object", - "properties": { - "relatedMetas": {}, - "client": { - "type": "string" - }, - "base_id": { - "type": "string" - }, - "columns": { - "allOf": [ - { - "anyOf": [ - { - "$ref": "#/components/schemas/GridColumn" - }, - { - "$ref": "#/components/schemas/FormColumn" - }, - { - "$ref": "#/components/schemas/GalleryColumn" - } - ] - }, - { - "$ref": "#/components/schemas/Column" - } - ] - }, - "model": { - "$ref": "#/components/schemas/Table" - } - } - }, - { - "type": "object", - "properties": { - "view": { - "anyOf": [ - { - "$ref": "#/components/schemas/Form" - }, - { - "$ref": "#/components/schemas/Grid" - }, - { - "$ref": "#/components/schemas/Gallery" - } - ] - } - } - } - ] - } - }, - "application/xml": { - "schema": {} - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Public"], - "description": "Get Share View Meta" - } - }, - "/api/v1/db/meta/audits/comments": { - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "get": { - "summary": "List Comments in Audit", - "operationId": "utils-comment-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "list": { - "x-stoplight": { - "id": "5zto1xohsngbu" - }, - "type": "array", - "items": { - "$ref": "#/components/schemas/Audit", - "x-stoplight": { - "id": "d22zkup0c0l80" - } - } - } - }, - "required": ["list"] - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "id": "adt_3sii7erfwrlegb", - "user": "w@nocodb.com", - "ip": null, - "base_id": null, - "project_id": "p_63b4q0qengen1x", - "fk_model_id": "md_5mipbdg6ketmv8", - "row_id": "1", - "op_type": "COMMENT", - "op_sub_type": null, - "status": null, - "description": "bar", - "details": null, - "created_at": "2023-03-13T09:39:14.225Z", - "updated_at": "2023-03-13T09:39:14.225Z" - }, - { - "id": "adt_fezs668qbxj8gc", - "user": "w@nocodb.com", - "ip": null, - "base_id": null, - "project_id": "p_63b4q0qengen1x", - "fk_model_id": "md_5mipbdg6ketmv8", - "row_id": "1", - "op_type": "COMMENT", - "op_sub_type": null, - "status": null, - "description": "foo", - "details": null, - "created_at": "2023-03-13T09:39:13.321Z", - "updated_at": "2023-03-13T09:39:13.321Z" - } - ] - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "List all comments", - "parameters": [ - { - "schema": { - "type": "string", - "example": "10" - }, - "in": "query", - "name": "row_id", - "required": true, - "description": "Row ID" - }, - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "md_c6csq89tl37jm5" - }, - "in": "query", - "name": "fk_model_id", - "required": true, - "description": "Foreign Key to Model" - }, - { - "schema": { - "type": "boolean", - "example": true - }, - "in": "query", - "name": "comments_only", - "description": "Is showing comments only?" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["Utils"] - }, - "post": { - "summary": "Comment Rows", - "operationId": "utils-comment-row", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Audit" - }, - "examples": { - "Example 1": { - "value": { - "user": "w@nocodb.com", - "row_id": "1", - "fk_model_id": "md_5mipbdg6ketmv8", - "op_type": "COMMENT", - "description": "qq", - "project_id": "p_63b4q0qengen1x", - "id": "adt_vx58jpp0loo8qy" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CommentReq" - }, - "examples": { - "Example 1": { - "value": { - "description": "This is the comment for the row", - "fk_model_id": "md_ehn5izr99m7d45", - "row_id": "3" - } - } - } - } - } - }, - "tags": ["Utils"], - "description": "Create a new comment in a row. Logged in Audit.", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/audits/{auditId}/comment": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "adt_zlskd6rlf3liay" - }, - "name": "auditId", - "in": "path", - "required": true, - "description": "Audit ID" - }, - { - "name": "xc-auth", - "in": "header", - "required": false, - "schema": { - "type": "string" - }, - "description": "Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN." - } - ], - "patch": { - "summary": "Update Comment in Audit", - "operationId": "utils-comment-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number", - "example": 1 - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - } - }, - "tags": ["Utils"], - "description": "Update comment in Audit", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CommentUpdateReq" - }, - "examples": { - "Example 1": { - "value": { - "description": "This is the comment for the row" - } - } - } - } - } - } - } - }, - "/api/v1/db/meta/audits/comments/count": { - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "get": { - "summary": "Count Comments", - "operationId": "utils-comment-count", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "x-stoplight": { - "id": "ziwcy4va5r1ao" - }, - "type": "object", - "properties": { - "count": { - "type": "string", - "x-stoplight": { - "id": "5r91gkxmaiyv4" - }, - "description": "The number of comments", - "example": "4" - }, - "row_id": { - "type": "string", - "x-stoplight": { - "id": "08sgorhq172sm" - }, - "description": "Row ID", - "example": "1" - } - }, - "required": ["count", "row_id"] - } - }, - "examples": { - "Example 1": { - "value": [ - { - "count": "4", - "row_id": "1" - } - ] - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Return the number of comments in the given query.", - "parameters": [ - { - "in": "query", - "name": "ids", - "required": true, - "description": "Comment IDs" - }, - { - "schema": { - "$ref": "#/components/schemas/Id" - }, - "in": "query", - "name": "fk_model_id", - "required": true, - "description": "Foreign Key to Model" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["Utils"] - } - }, - "/api/v1/db/meta/projects/{projectId}/audits": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - } - ], - "get": { - "summary": "List Audits in Project", - "operationId": "project-audit-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "list": { - "type": "array", - "uniqueItems": true, - "minItems": 1, - "items": { - "$ref": "#/components/schemas/Audit" - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated" - } - }, - "required": ["list", "pageInfo"] - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "List all audit data in the given project", - "parameters": [ - { - "schema": { - "type": "integer", - "minimum": 0 - }, - "in": "query", - "name": "offset" - }, - { - "schema": { - "type": "integer", - "maximum": 1 - }, - "in": "query", - "name": "limit" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["Project"] - } - }, - "/api/v1/db/meta/audits/rows/{rowId}/update": { - "parameters": [ - { - "schema": { - "example": "1" - }, - "name": "rowId", - "in": "path", - "required": true, - "description": "Unique Row ID" - } - ], - "post": { - "summary": "Update Audit Row", - "operationId": "utils-audit-row-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Audit" - }, - "examples": { - "Example 1": { - "value": { - "user": "w@nocodb.com", - "row_id": "1", - "fk_model_id": "md_5mipbdg6ketmv8", - "op_type": "COMMENT", - "description": "Table Sheet-1 : field Column A got changed from foo to bar", - "project_id": "p_63b4q0qengen1x", - "id": "adt_vx58jpp0loo8qy" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Utils"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AuditRowUpdateReq" - }, - "examples": { - "Example 1": { - "value": { - "column_name": "baz", - "fk_model_id": "md_ehn5izr99m7d45", - "row_id": "1", - "prev_value": "foo", - "value": "bar" - } - } - } - } - } - }, - "description": "Update Audit Row", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/tables/{tableId}/hooks": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "md_w9gpnaousnfss1", - "type": "string" - }, - "name": "tableId", - "in": "path", - "required": true, - "description": "Unique Table ID" - } - ], - "get": { - "summary": "List Table Hooks", - "operationId": "db-table-webhook-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HookList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "active": 0, - "async": 0, - "description": "This is my hook description", - "env": "all", - "event": "after", - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "string", - "notification": "{\"type\":\"URL\",\"payload\":{\"method\":\"POST\",\"body\":\"{{ json data }}\",\"headers\":[{}],\"parameters\":[{}],\"auth\":\"\",\"path\":\"http://example.com\"}}", - "null": null, - "operation": "insert", - "retries": 10, - "retry_interval": 60000, - "timeout": 60000, - "title": "My Webhook" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "List all hook records in the given Table", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["DB Table Webhook"] - }, - "post": { - "summary": "Create Table Hook", - "operationId": "db-table-webhook-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Hook" - }, - "examples": { - "Example 1": { - "value": { - "active": 0, - "async": 0, - "description": "This is my hook description", - "env": "all", - "event": "after", - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "string", - "notification": "{\"type\":\"URL\",\"payload\":{\"method\":\"POST\",\"body\":\"{{ json data }}\",\"headers\":[{}],\"parameters\":[{}],\"auth\":\"\",\"path\":\"http://example.com\"}}", - "null": null, - "operation": "insert", - "retries": 10, - "retry_interval": 60000, - "timeout": 60000, - "title": "My Webhook" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Create a hook in the given table", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HookReq" - }, - "examples": { - "Example 1": { - "value": { - "active": 0, - "async": 0, - "description": "This is my hook description", - "env": "all", - "event": "after", - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "string", - "notification": "{\"type\":\"URL\",\"payload\":{\"method\":\"POST\",\"body\":\"{{ json data }}\",\"headers\":[{}],\"parameters\":[{}],\"auth\":\"\",\"path\":\"http://example.com\"}}", - "null": null, - "operation": "insert", - "retries": 10, - "retry_interval": 60000, - "timeout": 60000, - "title": "My Webhook", - "condition": false - } - } - } - } - } - }, - "tags": ["DB Table Webhook"] - } - }, - "/api/v1/db/meta/tables/{tableId}/hooks/test": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "md_w9gpnaousnfss1", - "type": "string" - }, - "name": "tableId", - "in": "path", - "required": true, - "description": "Unique Table ID" - } - ], - "post": { - "summary": "Test Hook", - "operationId": "db-table-webhook-test", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "l5k90tzuvvv1g" - }, - "example": "The hook has been tested successfully" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "The hook has been tested successfully" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Webhook"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HookTestReq" - }, - "examples": { - "Example 1": { - "value": { - "hook": { - "active": 0, - "async": 0, - "description": "This is my hook description", - "env": "all", - "event": "after", - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "string", - "notification": "{\"type\":\"URL\",\"payload\":{\"method\":\"POST\",\"body\":\"{{ json data }}\",\"headers\":[{}],\"parameters\":[{}],\"auth\":\"\",\"path\":\"http://example.com\"}}", - "null": null, - "operation": "insert", - "retries": 10, - "retry_interval": 60000, - "timeout": 60000, - "title": "My Webhook" - }, - "payload": { - "data": { - "Id": 1, - "Title": "Sample Text", - "CreatedAt": "2023-03-03T10:03:06.484Z", - "UpdatedAt": "2023-03-03T10:03:06.484Z", - "attachment": [ - { - "url": "https://nocodb.com/dummy.png", - "title": "image.png", - "mimetype": "image/png", - "size": 0 - } - ], - "f": "Sample Output" - } - } - } - } - } - } - } - }, - "description": "Test the hook in the given Table", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/tables/{tableId}/hooks/samplePayload/{operation}/{version}": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "md_w9gpnaousnfss1", - "type": "string" - }, - "name": "tableId", - "in": "path", - "required": true, - "description": "Unique Table ID" - }, - { - "schema": { - "type": "string", - "enum": [ - "insert", - "update", - "delete", - "bulkInsert", - "bulkUpdate", - "bulkDelete" - ] - }, - "name": "operation", - "in": "path", - "required": true, - "description": "Hook Operation" - }, - { - "schema": { - "type": "string", - "enum": ["v1", "v2"] - }, - "name": "version", - "in": "path", - "required": true, - "description": "Hook Version" - } - ], - "get": { - "summary": "Get Sample Hook Payload", - "operationId": "db-table-webhook-sample-payload-get", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "data": { - "type": "object", - "x-stoplight": { - "id": "qifsikf69hqbl" - }, - "description": "Sample Payload Data" - } - } - }, - "examples": { - "Example 1": { - "value": { - "data": { - "Id": 1, - "Title": "Sample Text", - "CreatedAt": "2023-03-13T04:59:49.363Z", - "UpdatedAt": "2023-03-13T04:59:49.363Z" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Get the sample hook payload", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["DB Table Webhook"] - } - }, - "/api/v1/db/meta/hooks/{hookId}": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "hk_0063k4o1frnxbr" - }, - "name": "hookId", - "in": "path", - "required": true, - "description": "Unique Hook ID" - } - ], - "patch": { - "summary": "Update Hook", - "operationId": "db-table-webhook-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Hook" - }, - "examples": { - "Example 1": { - "value": { - "active": 0, - "async": 0, - "description": "This is my hook description", - "env": "all", - "event": "after", - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "string", - "notification": "{\"type\":\"URL\",\"payload\":{\"method\":\"POST\",\"body\":\"{{ json data }}\",\"headers\":[{}],\"parameters\":[{}],\"auth\":\"\",\"path\":\"http://example.com\"}}", - "null": null, - "operation": "insert", - "retries": 10, - "retry_interval": 60000, - "timeout": 60000, - "title": "My Webhook" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Webhook"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Hook" - }, - "examples": { - "Example 1": { - "value": { - "active": 0, - "async": 0, - "description": "This is my hook description", - "env": "all", - "event": "after", - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "string", - "notification": "{\"type\":\"URL\",\"payload\":{\"method\":\"POST\",\"body\":\"{{ json data }}\",\"headers\":[{}],\"parameters\":[{}],\"auth\":\"\",\"path\":\"http://example.com\"}}", - "null": null, - "operation": "insert", - "retries": 10, - "retry_interval": 60000, - "timeout": 60000, - "title": "My Webhook" - } - } - } - } - } - }, - "description": "Update the exsiting hook by its ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "delete": { - "summary": "Delete Hook", - "operationId": "db-table-webhook-delete", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "boolean" - }, - "examples": { - "Example 1": { - "value": true - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Webhook"], - "description": "Delete the exsiting hook by its ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/plugins": { - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "get": { - "summary": "List Plugins", - "operationId": "plugin-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "list": { - "type": "array", - "uniqueItems": true, - "minItems": 1, - "items": { - "$ref": "#/components/schemas/Plugin" - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "List all plugins", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["Plugin"] - } - }, - "/api/v1/db/meta/plugins/{pluginTitle}/status": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "pluginTitle", - "in": "path", - "required": true, - "description": "Plugin Title" - } - ], - "get": { - "summary": "Get Plugin Status", - "operationId": "plugin-status", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "boolean" - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Check plugin is active or not", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["Plugin"], - "x-internal": false - } - }, - "/api/v1/db/meta/plugins/test": { - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "post": { - "summary": "Test Plugin", - "operationId": "plugin-test", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": {} - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Test if the plugin is working with the given configurations", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["Plugin"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PluginTestReq" - }, - "examples": { - "Example 1": { - "value": { - "title": "Plugin Foo", - "input": "{\"bucket\":\"my-bucket\",\"region\":\"us-west-004\",\"access_key\":\"redacted\",\"access_secret\":\"redacted\"}", - "category": "Email" - } - } - } - } - } - } - } - }, - "/api/v1/db/meta/plugins/{pluginId}": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "pluginId", - "in": "path", - "required": true, - "description": "Plugin ID" - } - ], - "patch": { - "summary": "Update Plugin", - "operationId": "plugin-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": {} - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Plugin"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PluginReq" - } - } - } - }, - "description": "Update the plugin data by ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "x-internal": false - }, - "get": { - "summary": "Get Plugin", - "operationId": "plugin-read", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Plugin" - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Plugin"], - "description": "Get the plugin data by ID", - "x-internal": false - } - }, - "/api/v1/db/meta/connection/test": { - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "post": { - "summary": "Test DB Connection", - "operationId": "utils-test-connection", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "code": { - "type": "number" - }, - "message": { - "type": "string" - }, - "data": { - "type": "object", - "x-stoplight": { - "id": "6orbk04w97ien" - } - } - } - }, - "examples": { - "Example 1": { - "value": { - "code": 0, - "message": "", - "data": {} - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Utils"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "x-examples": { - "Example 1": { - "client": "mysql2", - "connection": { - "host": "localhost", - "port": "3306", - "user": "root", - "password": "password", - "database": null - } - } - }, - "properties": { - "client": { - "description": "DB Type", - "enum": [ - "mssql", - "mysql", - "mysql2", - "oracledb", - "pg", - "snowflake", - "sqlite3" - ], - "example": "mysql2", - "type": "string" - }, - "connection": { - "type": "object", - "properties": { - "host": { - "type": "string" - }, - "port": { - "type": "string" - }, - "user": { - "type": "string" - }, - "password": { - "type": "string" - }, - "database": { - "$ref": "#/components/schemas/StringOrNull" - } - } - } - } - }, - "examples": { - "Example 1": { - "value": { - "client": "mysql2", - "connection": { - "host": "localhost", - "port": "3306", - "user": "root", - "password": "password", - "database": null - } - } - } - } - } - } - }, - "description": "Test the DB Connection", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/url_to_config": { - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "post": { - "summary": "Convert JDBC URL to Config", - "operationId": "utils-url-to-config", - "tags": ["Utils"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "url": { - "type": "string", - "x-stoplight": { - "id": "fgdbmcjjtkky5" - }, - "description": "JDBC URL", - "example": "jdbc:mysql://username:password@localhost:3306/sakila" - } - } - }, - "examples": { - "Example 1": { - "value": { - "url": "jdbc:mysql://username:password@localhost:3306/sakila" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "x-examples": { - "Example 1": { - "client": "mysql2", - "connection": { - "user": "username", - "password": "password", - "database": "sakila", - "host": "localhost", - "port": "3306" - } - } - }, - "properties": { - "client": { - "description": "DB Type", - "enum": [ - "mssql", - "mysql", - "mysql2", - "oracledb", - "pg", - "snowflake", - "sqlite3" - ], - "example": "mysql2", - "type": "string" - }, - "connection": { - "type": "object", - "description": "Connection Config", - "properties": { - "user": { - "type": "string", - "description": "DB User" - }, - "password": { - "type": "string", - "description": "DB Password" - }, - "database": { - "type": "string", - "description": "DB Name" - }, - "host": { - "type": "string", - "description": "DB Host" - }, - "port": { - "type": "string", - "description": "DB Host" - } - } - } - } - }, - "examples": { - "Example 1": { - "value": { - "client": "mysql2", - "connection": { - "user": "username", - "password": "password", - "database": "sakila", - "host": "localhost", - "port": "3306" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Extract XC URL From JDBC and parse to connection config", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/nocodb/info": { - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "get": { - "summary": "Get App Info", - "operationId": "utils-app-info", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "x-examples": { - "Example 1": { - "authType": "jwt", - "projectHasAdmin": true, - "firstUser": false, - "type": "rest", - "googleAuthEnabled": false, - "githubAuthEnabled": false, - "oneClick": false, - "connectToExternalDB": true, - "version": "0.105.3", - "defaultLimit": 25, - "ncMin": false, - "teleEnabled": false, - "auditEnabled": true, - "ncSiteUrl": "http://localhost:8080", - "ee": false, - "ncAttachmentFieldSize": 20971520, - "ncMaxAttachmentsAllowed": 10 - } - }, - "properties": { - "authType": { - "type": "string" - }, - "projectHasAdmin": { - "type": "boolean" - }, - "firstUser": { - "type": "boolean" - }, - "type": { - "type": "string" - }, - "googleAuthEnabled": { - "type": "boolean" - }, - "githubAuthEnabled": { - "type": "boolean" - }, - "oneClick": { - "type": "boolean" - }, - "connectToExternalDB": { - "type": "boolean" - }, - "version": { - "type": "string" - }, - "defaultLimit": { - "type": "number" - }, - "ncMin": { - "type": "boolean" - }, - "teleEnabled": { - "type": "boolean" - }, - "auditEnabled": { - "type": "boolean" - }, - "ncSiteUrl": { - "type": "string" - }, - "ee": { - "type": "boolean" - }, - "ncAttachmentFieldSize": { - "type": "number" - }, - "ncMaxAttachmentsAllowed": { - "type": "number" - }, - "isCloud": { - "type": "boolean", - "x-stoplight": { - "id": "bstdkpky2131f" - } - }, - "automationLogLevel": { - "type": "string", - "x-stoplight": { - "id": "uc3vaotye2eu8" - }, - "enum": ["OFF", "ERROR", "ALL"], - "example": "OFF" - } - } - }, - "examples": { - "Example 1": { - "value": { - "authType": "jwt", - "projectHasAdmin": true, - "firstUser": false, - "type": "rest", - "googleAuthEnabled": false, - "githubAuthEnabled": false, - "oneClick": false, - "connectToExternalDB": true, - "version": "0.105.3", - "defaultLimit": 25, - "ncMin": false, - "teleEnabled": false, - "auditEnabled": true, - "ncSiteUrl": "http://localhost:8080", - "ee": false, - "ncAttachmentFieldSize": 20971520, - "ncMaxAttachmentsAllowed": 10, - "isCloud": false, - "automationLogLevel": "OFF" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Utils"], - "description": "Get the application info such as authType, defaultLimit, version and etc.", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/axiosRequestMake": { - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "post": { - "summary": "Axios Request", - "operationId": "utils-axios-request-make", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {} - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Generic Axios Call", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object" - } - } - } - }, - "tags": ["Utils"], - "x-internal": true, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/version": { - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "get": { - "summary": "Get App Version", - "operationId": "utils-app-version", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "x-examples": { - "Example 1": { - "currentVersion": "0.105.3", - "releaseVersion": "0.105.3" - } - }, - "properties": { - "currentVersion": { - "type": "string", - "description": "Current NocoDB Version", - "example": "0.104.0" - }, - "releaseVersion": { - "type": "string", - "description": "Latest Release Version", - "example": "0.105.3" - } - } - }, - "examples": { - "Example 1": { - "value": { - "currentVersion": "0.104.0", - "releaseVersion": "0.105.3" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Utils"], - "description": "Get the application version", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/health": { - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "get": { - "summary": "Get Application Health Status", - "operationId": "utils-app-health", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "x-examples": { - "Example 1": { - "message": "OK", - "timestamp": 1678702175755, - "uptime": 1618.996877834 - } - }, - "properties": { - "message": { - "type": "string", - "example": "OK" - }, - "timestamp": { - "type": "string", - "example": "1678702175755" - }, - "uptime": { - "type": "string", - "example": "1618.996877834" - } - } - }, - "examples": { - "Example 1": { - "value": { - "message": "OK", - "timestamp": 1678702175755, - "uptime": 1618.996877834 - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Utils"], - "description": "Get Application Health Status", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/aggregated-meta-info": { - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "get": { - "summary": "Get Aggregated Meta Info", - "operationId": "utils-aggregated-meta-info", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "projectCount": { - "type": "integer" - }, - "projects": { - "type": "array", - "items": { - "type": "object", - "properties": { - "tableCount": { - "type": "object", - "properties": { - "table": { - "type": "integer", - "description": "Table Count" - }, - "view": { - "type": "integer", - "description": "View Count" - } - } - }, - "external": { - "type": "boolean", - "description": "External Project", - "default": false - }, - "viewCount": { - "type": "object", - "properties": { - "formCount": { - "type": "integer", - "description": "Form Count" - }, - "gridCount": { - "type": "integer", - "description": "Grid Count" - }, - "galleryCount": { - "type": "integer", - "description": "Gallery Count" - }, - "kanbanCount": { - "type": "integer", - "description": "Kanban Count" - }, - "total": { - "type": "integer", - "description": "Total View Count" - }, - "sharedFormCount": { - "type": "integer", - "description": "Shared Form Count" - }, - "sharedGridCount": { - "type": "integer", - "description": "Shared Grid Count" - }, - "sharedGalleryCount": { - "type": "integer", - "description": "Shared Gallery Count" - }, - "sharedKanbanCount": { - "type": "integer", - "description": "Shared Kanban Count" - }, - "sharedTotal": { - "type": "integer", - "description": "Shared Total View Count" - }, - "sharedLockedCount": { - "type": "integer", - "description": "Shared Locked View Count" - } - } - }, - "webhookCount": { - "type": "integer", - "description": "Webhook Count" - }, - "filterCount": { - "type": "integer", - "description": "Filter Count" - }, - "sortCount": { - "type": "integer", - "description": "Sort Count" - }, - "rowCount": { - "type": "array", - "items": { - "type": "object", - "properties": { - "TotalRecords": { - "type": "string" - } - } - }, - "description": "Row Count" - }, - "userCount": { - "type": "integer", - "description": "Total project user Count" - } - } - } - }, - "userCount": { - "type": "integer", - "description": "Total user Count" - }, - "sharedBaseCount": { - "type": "integer", - "description": "Total shared base Count" - } - }, - "x-examples": { - "Example 1": { - "projectCount": 1, - "projects": [ - { - "tableCount": { - "table": 3, - "view": 0 - }, - "external": false, - "viewCount": { - "formCount": 0, - "gridCount": 3, - "galleryCount": 0, - "kanbanCount": 0, - "total": 3, - "sharedFormCount": 0, - "sharedGridCount": 0, - "sharedGalleryCount": 0, - "sharedKanbanCount": 0, - "sharedTotal": 0, - "sharedLockedCount": 0 - }, - "webhookCount": 0, - "filterCount": 0, - "sortCount": 0, - "rowCount": [ - { - "TotalRecords": "76" - } - ], - "userCount": 1 - } - ], - "userCount": 1, - "sharedBaseCount": 0 - } - } - }, - "examples": { - "example-1": { - "value": { - "projectCount": 1, - "projects": [ - { - "tableCount": { - "table": 3, - "view": 0 - }, - "external": false, - "viewCount": { - "formCount": 0, - "gridCount": 3, - "galleryCount": 0, - "kanbanCount": 0, - "total": 3, - "sharedFormCount": 0, - "sharedGridCount": 0, - "sharedGalleryCount": 0, - "sharedKanbanCount": 0, - "sharedTotal": 0, - "sharedLockedCount": 0 - }, - "webhookCount": 0, - "filterCount": 0, - "sortCount": 0, - "rowCount": [ - { - "TotalRecords": "76" - } - ], - "userCount": 1 - } - ], - "userCount": 1, - "sharedBaseCount": 0 - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Utils"], - "description": "Get Aggregated Meta Info such as tableCount, dbViewCount, viewCount and etc.", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/cache": { - "get": { - "summary": "Get Cache", - "tags": ["Utils"], - "responses": {}, - "operationId": "utils-cache-get", - "description": "Get All K/V pairs in NocoCache", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "delete": { - "summary": "Delete Cache", - "operationId": "utils-cache-delete", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "boolean" - }, - "examples": { - "Example 1": { - "value": true - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Delete All K/V pairs in NocoCache", - "tags": ["Utils"], - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "/api/v1/db/meta/projects/{projectId}/api-tokens": { - "get": { - "summary": "List API Tokens in Project", - "tags": ["API Token"], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiTokenList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "id": "1", - "fk_user_id": "us_b3xo2i44nx5y9l", - "description": "This API Token is for ABC application", - "token": "DYh540o8hbWpUGdarekECKLdN5OhlgCUWutVJYX2" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "operationId": "api-token-list", - "description": "List API Tokens in the given project", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "post": { - "summary": "Create API Token", - "operationId": "api-token-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiToken" - }, - "examples": { - "Example 1": { - "value": { - "id": "1", - "fk_user_id": "us_b3xo2i44nx5y9l", - "description": "This API Token is for ABC application", - "token": "DYh540o8hbWpUGdarekECKLdN5OhlgCUWutVJYX2" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiTokenReq" - }, - "examples": { - "Example 1": { - "value": { - "description": "This API token is for ABC application" - } - } - } - } - }, - "description": "" - }, - "tags": ["API Token"], - "description": "Create API Token in a project", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - } - ] - }, - "/api/v1/db/meta/projects/{projectId}/api-tokens/{token}": { - "delete": { - "summary": "Delete API Token", - "operationId": "api-token-delete", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number", - "example": 1 - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["API Token"], - "description": "Delete the given API Token in project", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - }, - { - "schema": { - "type": "string", - "example": "DYh540o8hbWpUGdarekECKLdN5OhlgCUWutVJYX2" - }, - "name": "token", - "in": "path", - "required": true, - "description": "API Token" - } - ] - }, - "/api/v1/db/storage/upload": { - "post": { - "summary": "Attachment Upload", - "operationId": "storage-upload", - "responses": {}, - "tags": ["Storage"], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "$ref": "#/components/schemas/AttachmentReq" - }, - "examples": { - "Example 1": { - "value": { - "mimetype": "image/jpeg", - "path": "download/noco/jango_fett/Table1/attachment/uVbjPVQxC_SSfs8Ctx.jpg", - "size": 13052, - "title": "22bc-kavypmq4869759 (1).jpg" - } - } - } - } - }, - "description": "" - }, - "parameters": [ - { - "schema": { - "type": "string", - "example": "download/noco/jango_fett/Table1/attachment/uVbjPVQxC_SSfs8Ctx.jpg" - }, - "name": "path", - "in": "query", - "required": true, - "description": "Target File Path" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "description": "Upload attachment" - } - }, - "/api/v1/db/storage/upload-by-url": { - "post": { - "summary": "Attachment Upload by URL", - "operationId": "storage-upload-by-url", - "responses": {}, - "tags": ["Storage"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AttachmentReq" - } - }, - "examples": {} - } - } - }, - "parameters": [ - { - "schema": { - "type": "string", - "example": "download/noco/jango_fett/Table1/attachment/c7z_UF8sZBgJUxMjpN.jpg" - }, - "name": "path", - "in": "query", - "description": "Target File Path", - "required": true - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "description": "Upload attachment by URL. Used in Airtable Migration." - } - }, - "/api/v1/db/meta/projects/{projectId}/users/{userId}/resend-invite": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - }, - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "us_b3xo2i44nx5y9l" - }, - "name": "userId", - "in": "path", - "required": true, - "description": "Unique User ID" - } - ], - "post": { - "summary": "Resend User Invitation", - "operationId": "auth-project-user-resend-invite", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "m570oh5j3afjt" - }, - "description": "Success Message", - "example": "The invitation has been sent to the user" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "The invitation has been sent to the user" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Auth"], - "description": "Resend Invitation to a specific user", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - } - }, - "components": { - "schemas": { - "ApiToken": { - "description": "Model for API Token", - "examples": [ - { - "id": "1", - "fk_user_id": "us_b3xo2i44nx5y9l", - "description": "This API Token is for ABC application", - "token": "DYh540o8hbWpUGdarekECKLdN5OhlgCUWutVJYX2" - } - ], - "title": "API Token Model", - "type": "object", - "properties": { - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique API Token ID" - }, - "fk_user_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to User" - }, - "description": { - "type": "string", - "description": "API Token Description", - "example": "This API Token is for ABC application" - }, - "token": { - "type": "string", - "description": "API Token", - "example": "DYh540o8hbWpUGdarekECKLdN5OhlgCUWutVJYX2" - } - }, - "x-stoplight": { - "id": "95rfb0httdmw0" - } - }, - "ApiTokenReq": { - "description": "Model for API Token Request", - "examples": [ - { - "description": "This API token is for ABC application" - } - ], - "title": "API Token Request Model", - "type": "object", - "properties": { - "description": { - "description": "Description of the API token", - "maxLength": 255, - "type": "string", - "example": "This API Token is for ABC application" - } - }, - "x-stoplight": { - "id": "h3g2houpa6y9y" - } - }, - "ApiTokenList": { - "description": "Model for API Token List", - "x-stoplight": { - "id": "35b7cvjplxmfm" - }, - "examples": [ - { - "list": [ - { - "id": "1", - "fk_user_id": "us_b3xo2i44nx5y9l", - "description": "This API Token is for ABC application", - "token": "DYh540o8hbWpUGdarekECKLdN5OhlgCUWutVJYX2" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - ], - "title": "API Token List Model", - "type": "object", - "properties": { - "list": { - "type": "array", - "example": [ - { - "list": [ - { - "id": "1", - "fk_user_id": "us_b3xo2i44nx5y9l", - "description": "This API Token is for ABC application", - "token": "DYh540o8hbWpUGdarekECKLdN5OhlgCUWutVJYX2" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - ], - "x-stoplight": { - "id": "c7xu43yjgyjww" - }, - "description": "List of api token objects", - "items": { - "$ref": "#/components/schemas/ApiToken", - "x-stoplight": { - "id": "5ih4l0ix2tr5q" - } - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated", - "x-stoplight": { - "id": "0w8ktfnx3pusz" - }, - "description": "Model for Paginated" - } - }, - "required": ["list", "pageInfo"] - }, - "Attachment": { - "description": "Model for Attachment", - "examples": [ - { - "data": null, - "mimetype": "image/jpeg", - "path": "download/noco/jango_fett/Table1/attachment/c7z_UF8sZBgJUxMjpN.jpg", - "size": 12345, - "title": "kavypmq4869759.jpg" - } - ], - "title": "Attachment Model", - "type": "object", - "properties": { - "data": { - "description": "Data for uploading" - }, - "mimetype": { - "type": "string", - "description": "The mimetype of the attachment" - }, - "path": { - "type": "string", - "description": "File Path" - }, - "size": { - "type": "number", - "description": "Attachment Size" - }, - "title": { - "type": "string", - "description": "The title of the attachment. Used in UI." - }, - "url": { - "type": "string", - "description": "Attachment URL" - } - }, - "x-stoplight": { - "id": "pbx8hqgwdz7lw" - } - }, - "AttachmentReq": { - "description": "Model for Attachment Request", - "type": "object", - "x-examples": { - "Example 1": { - "mimetype": "image/jpeg", - "path": "download/noco/jango_fett/Table1/attachment/uVbjPVQxC_SSfs8Ctx.jpg", - "size": 13052, - "title": "22bc-kavypmq4869759 (1).jpg" - } - }, - "title": "Attachment Request Model", - "properties": { - "mimetype": { - "type": "string", - "description": "The mimetype of the attachment" - }, - "path": { - "type": "string", - "description": "The file path of the attachment" - }, - "size": { - "type": "number", - "description": "The size of the attachment" - }, - "title": { - "type": "string", - "description": "The title of the attachment used in UI" - }, - "url": { - "type": "string", - "description": "Attachment URL to be uploaded via upload-by-url" - } - }, - "x-stoplight": { - "id": "jmahtr8c5rw7f" - } - }, - "Audit": { - "description": "Model for Audit", - "examples": [ - { - "id": "adt_l5we7pkx70vaao", - "user": "w@nocodb.com", - "ip": "::ffff:127.0.0.1", - "base_id": "ds_3l9qx8xqksenrl", - "project_id": "p_9sx43moxhqtjm3", - "fk_model_id": "md_ehn5izr99m7d45", - "row_id": "rec0Adp9PMG9o7uJy", - "op_type": "AUTHENTICATION", - "op_sub_type": "UPDATE", - "status": "string", - "description": "Table nc_snms___Table_1 : field Date got changed from 2023-03-12 to ", - "details": "Date : 2023-03-12 " - } - ], - "title": "Audit Model", - "type": "object", - "properties": { - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "user": { - "type": "string", - "description": "The user name performing the action", - "example": "w@nocodb.com" - }, - "ip": { - "type": "string", - "example": "::ffff:127.0.0.1", - "description": "IP address from the user" - }, - "base_id": { - "type": "string", - "description": "Base ID in where action is performed", - "example": "ds_3l9qx8xqksenrl" - }, - "project_id": { - "type": "string", - "description": "Project ID in where action is performed", - "example": "p_9sx43moxhqtjm3" - }, - "fk_model_id": { - "type": "string", - "description": "Model ID in where action is performed", - "example": "md_ehn5izr99m7d45" - }, - "row_id": { - "type": "string", - "description": "Row ID", - "example": "rec0Adp9PMG9o7uJy" - }, - "op_type": { - "type": "string", - "description": "Operation Type", - "example": "AUTHENTICATION", - "enum": [ - "COMMENT", - "DATA", - "PROJECT", - "VIRTUAL_RELATION", - "RELATION", - "TABLE_VIEW", - "TABLE", - "VIEW", - "META", - "WEBHOOKS", - "AUTHENTICATION", - "TABLE_COLUMN", - "ORG_USER" - ] - }, - "op_sub_type": { - "type": "string", - "description": "Operation Sub Type", - "example": "UPDATE", - "enum": [ - "UPDATE", - "INSERT", - "BULK_INSERT", - "BULK_UPDATE", - "BULK_DELETE", - "LINK_RECORD", - "UNLINK_RECORD", - "DELETE", - "CREATE", - "RENAME", - "IMPORT_FROM_ZIP", - "EXPORT_TO_FS", - "EXPORT_TO_ZIP", - "SIGNIN", - "SIGNUP", - "PASSWORD_RESET", - "PASSWORD_FORGOT", - "PASSWORD_CHANGE", - "EMAIL_VERIFICATION", - "ROLES_MANAGEMENT", - "INVITE", - "RESEND_INVITE" - ] - }, - "status": { - "type": "string", - "description": "Audit Status" - }, - "description": { - "type": "string", - "description": "Description of the action", - "example": "Table nc_snms___Table_1 : field Date got changed from 2023-03-12 to " - }, - "details": { - "type": "string", - "description": "Detail", - "example": "Date : 2023-03-12 " - } - }, - "x-stoplight": { - "id": "i5ug0n7j1wub8" - } - }, - "AuditRowUpdateReq": { - "description": "Model for Audit Row Update Request", - "examples": [ - { - "column_name": "baz", - "fk_model_id": "md_ehn5izr99m7d45", - "row_id": "rec0Adp9PMG9o7uJy", - "prev_value": "foo", - "value": "bar" - } - ], - "title": "Audit Row Update Request Model", - "type": "object", - "properties": { - "column_name": { - "type": "string", - "description": "Column Name", - "example": "baz" - }, - "fk_model_id": { - "type": "string", - "description": "Foreign Key to Model", - "example": "md_ehn5izr99m7d45" - }, - "row_id": { - "type": "string", - "example": "rec0Adp9PMG9o7uJy", - "description": "Row ID" - }, - "prev_value": { - "description": "The previous value before the action" - }, - "value": { - "description": "The current value after the action" - } - }, - "x-stoplight": { - "id": "jcw57b1yv3xog" - } - }, - "Base": { - "description": "Model for Base", - "examples": [ - { - "alias": null, - "config": "", - "enabled": 1, - "id": "ds_krsappzu9f8vmo", - "inflection_column": "camelize", - "inflection_table": "camelize", - "is_meta": 1, - "meta": null, - "order": 1, - "project_id": "p_01clqvzik3izk6", - "type": "mysql2" - } - ], - "title": "Base Model", - "type": "object", - "properties": { - "alias": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Base Name - Default BASE will be null by default" - }, - "config": { - "description": "Base Configuration" - }, - "enabled": { - "$ref": "#/components/schemas/Bool", - "description": "Is this base enabled" - }, - "id": { - "description": "Unique Base ID", - "type": "string" - }, - "inflection_column": { - "description": "Inflection for columns", - "example": "camelize", - "type": "string" - }, - "inflection_table": { - "description": "Inflection for tables", - "example": "camelize", - "type": "string" - }, - "is_meta": { - "$ref": "#/components/schemas/Bool", - "description": "Is the data source connected externally" - }, - "order": { - "description": "The order of the list of bases", - "example": 1, - "type": "number" - }, - "project_id": { - "description": "The project ID that this base belongs to", - "type": "string" - }, - "type": { - "description": "DB Type", - "enum": [ - "mssql", - "mysql", - "mysql2", - "oracledb", - "pg", - "snowflake", - "sqlite3" - ], - "example": "mysql2", - "type": "string" - } - }, - "x-stoplight": { - "id": "9hy3cgp0r2c95" - } - }, - "BaseList": { - "description": "Model for Base List", - "examples": [ - { - "list": [ - { - "alias": null, - "config": "", - "enabled": 1, - "id": "ds_krsappzu9f8vmo", - "inflection_column": "camelize", - "inflection_table": "camelize", - "is_meta": 1, - "meta": null, - "order": 1, - "project_id": "p_01clqvzik3izk6", - "type": "mysql2" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - ], - "title": "Base List Model", - "type": "object", - "x-examples": { - "example-1": { - "bases": { - "list": [ - { - "alias": "sakila", - "config": "", - "created_at": "2023-03-02 11:28:17", - "enabled": 1, - "id": "ds_btbdt19zde0gj9", - "inflection_column": "camelize", - "inflection_table": "camelize", - "is_meta": null, - "meta": null, - "order": 2, - "project_id": "p_01clqvzik3izk6", - "type": "mysql2", - "updated_at": "2023-03-02 11:28:17" - }, - { - "alias": null, - "config": "", - "created_at": "2023-03-01 16:31:49", - "enabled": 1, - "id": "ds_krsappzu9f8vmo", - "inflection_column": "camelize", - "inflection_table": "camelize", - "is_meta": 1, - "meta": null, - "order": 1, - "project_id": "p_01clqvzik3izk6", - "type": "mysql2", - "updated_at": "2023-03-02 11:28:17" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 2, - "totalRows": 2 - } - } - } - }, - "properties": { - "list": { - "type": "array", - "x-stoplight": { - "id": "1q3ny60j1g4z2" - }, - "description": "List of base objects", - "items": { - "$ref": "#/components/schemas/Base", - "x-stoplight": { - "id": "udd0nrcv6pq8d" - } - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated", - "x-stoplight": { - "id": "xqwcniocq37hk" - }, - "description": "Paginated Info" - } - }, - "required": ["list", "pageInfo"], - "x-stoplight": { - "id": "kk8uqxeefumma" - } - }, - "BaseReq": { - "description": "Model for Base Request", - "examples": [ - { - "alias": "My Base", - "config": null, - "inflection_column": "camelize", - "inflection_table": "camelize", - "is_meta": true, - "type": "mysql" - } - ], - "properties": { - "alias": { - "description": "Base Name - Default BASE will be null by default", - "example": "My Base", - "maxLength": 128, - "type": "string" - }, - "config": { - "description": "Base Configuration" - }, - "inflection_column": { - "description": "Inflection for columns", - "example": "camelize", - "type": "string" - }, - "inflection_table": { - "description": "Inflection for tables", - "example": "camelize", - "type": "string" - }, - "is_meta": { - "description": "Is the data source connected externally", - "type": "boolean" - }, - "type": { - "description": "DB Type", - "enum": [ - "mssql", - "mysql", - "mysql2", - "oracledb", - "pg", - "snowflake", - "sqlite3" - ], - "type": "string" - } - }, - "title": "Base Request", - "type": "object", - "x-stoplight": { - "id": "j2z6ain3204zi" - } - }, - "Bool": { - "description": "Model for Bool", - "examples": [true], - "oneOf": [ - { - "description": "0 or 1", - "example": 0, - "type": "integer" - }, - { - "description": "true or false", - "type": "boolean" - }, - { - "type": "null" - } - ], - "title": "Bool Model", - "x-stoplight": { - "id": "8n3vnyr22sbvj" - } - }, - "Column": { - "description": "Model for Column", - "examples": [ - { - "ai": 0, - "au": 0, - "base_id": "ds_krsappzu9f8vmo", - "cc": "", - "cdf": null, - "clen": "45", - "column_name": "title", - "cop": "2", - "created_at": "2023-03-02 13:14:16", - "csn": "utf8mb4", - "ct": "varchar(45)", - "deleted": null, - "dt": "varchar", - "dtx": "specificType", - "dtxp": "45", - "dtxs": null, - "fk_model_id": "md_yvwvbt2i78rgcm", - "id": "cl_0j9gv0oi8vjy46", - "meta": null, - "np": null, - "ns": null, - "order": 2, - "pk": 0, - "project_id": "p_01clqvzik3izk6", - "pv": 1, - "rqd": 0, - "system": 0, - "title": "Title", - "uidt": "SingleLineText", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 13:14:16", - "validate": null, - "virtual": null - } - ], - "title": "Column Model", - "type": "object", - "properties": { - "ai": { - "$ref": "#/components/schemas/Bool", - "description": "Is Auto-Increment?" - }, - "au": { - "$ref": "#/components/schemas/Bool", - "description": "Auto Update Timestamp" - }, - "base_id": { - "description": "Base ID that this column belongs to", - "example": "ds_krsappzu9f8vmo", - "type": "string" - }, - "cc": { - "description": "Column Comment", - "type": "string" - }, - "cdf": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Column Default" - }, - "clen": { - "description": "Character Maximum Length", - "oneOf": [ - { - "type": "integer" - }, - { - "type": "null" - }, - { - "type": "string" - } - ] - }, - "colOptions": { - "anyOf": [ - { - "$ref": "#/components/schemas/Formula" - }, - { - "$ref": "#/components/schemas/LinkToAnotherRecord" - }, - { - "$ref": "#/components/schemas/Lookup" - }, - { - "$ref": "#/components/schemas/Rollup" - }, - { - "$ref": "#/components/schemas/SelectOptions" - }, - { - "type": "object" - } - ], - "description": "Column Options" - }, - "column_name": { - "description": "Column Name", - "example": "title", - "type": "string" - }, - "cop": { - "description": "Column Ordinal Position", - "type": "string" - }, - "csn": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Character Set Name" - }, - "ct": { - "description": "Column Type", - "example": "varchar(45)", - "type": "string" - }, - "deleted": { - "$ref": "#/components/schemas/Bool", - "description": "Is Deleted?" - }, - "dt": { - "description": "Data Type in DB", - "example": "varchar", - "type": "string" - }, - "dtx": { - "description": "Data Type X", - "example": "specificType", - "type": "string" - }, - "dtxp": { - "description": "Data Type X Precision", - "oneOf": [ - { - "type": "null" - }, - { - "type": "number" - }, - { - "type": "string" - } - ] - }, - "dtxs": { - "description": "Data Type X Scale", - "oneOf": [ - { - "type": "null" - }, - { - "type": "number" - }, - { - "type": "string" - } - ] - }, - "fk_model_id": { - "description": "Model ID that this column belongs to", - "example": "md_yvwvbt2i78rgcm", - "type": "string" - }, - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "description": "Meta Info" - }, - "np": { - "description": "Numeric Precision", - "oneOf": [ - { - "type": "integer" - }, - { - "type": "null" - }, - { - "type": "string" - } - ] - }, - "ns": { - "description": "Numeric Scale", - "oneOf": [ - { - "type": "integer" - }, - { - "type": "null" - }, - { - "type": "string" - } - ] - }, - "order": { - "description": "The order of the list of columns", - "type": "number" - }, - "pk": { - "$ref": "#/components/schemas/Bool", - "description": "Is Primary Key?" - }, - "pv": { - "$ref": "#/components/schemas/Bool", - "description": "Is Primary Value?" - }, - "rqd": { - "$ref": "#/components/schemas/Bool", - "description": "Is Required?" - }, - "system": { - "$ref": "#/components/schemas/Bool", - "description": "Is System Column?" - }, - "title": { - "description": "Column Title", - "example": "Title", - "type": "string" - }, - "uidt": { - "description": "The data type in UI", - "example": "SingleLineText", - "enum": [ - "Attachment", - "AutoNumber", - "Barcode", - "Button", - "Checkbox", - "Collaborator", - "Count", - "CreateTime", - "Currency", - "Date", - "DateTime", - "Decimal", - "Duration", - "Email", - "Formula", - "ForeignKey", - "GeoData", - "Geometry", - "ID", - "JSON", - "LastModifiedTime", - "LongText", - "LinkToAnotherRecord", - "Lookup", - "MultiSelect", - "Number", - "Percent", - "PhoneNumber", - "Rating", - "Rollup", - "SingleLineText", - "SingleSelect", - "SpecificDBType", - "Time", - "URL", - "Year", - "QrCode" - ], - "type": "string" - }, - "un": { - "$ref": "#/components/schemas/Bool", - "description": "Is Unsigned?" - }, - "unique": { - "$ref": "#/components/schemas/Bool", - "description": "Is unique?" - }, - "visible": { - "$ref": "#/components/schemas/Bool", - "description": "Is Visible?" - } - }, - "x-stoplight": { - "id": "3a4lsn477mx4e" - } - }, - "ColumnList": { - "description": "Model for Column List", - "examples": [ - { - "list": [ - { - "ai": 0, - "au": 0, - "base_id": "ds_krsappzu9f8vmo", - "cc": "", - "cdf": null, - "clen": "45", - "column_name": "title", - "cop": "2", - "created_at": "2023-03-02 13:14:16", - "csn": "utf8mb4", - "ct": "varchar(45)", - "deleted": null, - "dt": "varchar", - "dtx": "specificType", - "dtxp": "45", - "dtxs": null, - "fk_model_id": "md_yvwvbt2i78rgcm", - "id": "cl_0j9gv0oi8vjy46", - "meta": null, - "np": null, - "ns": null, - "order": 2, - "pk": 0, - "project_id": "p_01clqvzik3izk6", - "pv": 1, - "rqd": 0, - "system": 0, - "title": "Title", - "uidt": "SingleLineText", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 13:14:16", - "validate": null, - "virtual": null - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - ], - "title": "Column List Model", - "type": "object", - "x-examples": { - "example-1": { - "bases": { - "list": [ - { - "alias": "string", - "database": "string", - "host": "string", - "id": "string", - "params": "string", - "password": "string", - "port": 0, - "project_id": "string", - "ssl": "string", - "type": "string", - "url": "string", - "username": "string" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "pageSize": 0, - "sort": "string", - "totalRows": 0 - } - } - } - }, - "properties": { - "list": { - "type": "array", - "x-stoplight": { - "id": "c6lpw8px25356" - }, - "description": "List of column objects", - "items": { - "$ref": "#/components/schemas/Column", - "x-stoplight": { - "id": "zbm89i86dr73y" - } - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated", - "x-stoplight": { - "id": "ko0s0z13h4hsw" - } - } - }, - "required": ["list", "pageInfo"], - "x-stoplight": { - "id": "rldg44w1alasg" - } - }, - "ColumnReq": { - "allOf": [ - { - "anyOf": [ - { - "$ref": "#/components/schemas/FormulaColumnReq" - }, - { - "$ref": "#/components/schemas/LinkToAnotherColumnReq" - }, - { - "$ref": "#/components/schemas/LookupColumnReq" - }, - { - "$ref": "#/components/schemas/NormalColumnRequest" - }, - { - "$ref": "#/components/schemas/RollupColumnReq" - } - ] - }, - { - "properties": { - "column_name": { - "type": "string" - }, - "column_order": { - "description": "Column order in a specific view", - "properties": { - "order": { - "type": "number" - }, - "view_id": { - "type": "string" - } - }, - "type": "object" - }, - "title": { - "maxLength": 255, - "minLength": 1, - "type": "string" - } - }, - "required": ["title"] - } - ], - "description": "Model for Column Request", - "examples": [ - { - "ai": 0, - "au": 0, - "base_id": "ds_krsappzu9f8vmo", - "cc": "", - "cdf": null, - "clen": "45", - "column_name": "title", - "cop": "2", - "created_at": "2023-03-02 13:14:16", - "csn": "utf8mb4", - "ct": "varchar(45)", - "deleted": null, - "dt": "varchar", - "dtx": "specificType", - "dtxp": "45", - "dtxs": null, - "fk_model_id": "md_yvwvbt2i78rgcm", - "id": "cl_0j9gv0oi8vjy46", - "meta": null, - "np": null, - "ns": null, - "order": 2, - "pk": 0, - "project_id": "p_01clqvzik3izk6", - "pv": 1, - "rqd": 0, - "system": 0, - "title": "Title", - "uidt": "SingleLineText", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 13:14:16", - "validate": null, - "virtual": null - } - ], - "title": "Column Request Model", - "type": "object", - "x-stoplight": { - "id": "dvbn9dnme6jgi" - } - }, - "CommentReq": { - "description": "Model for Comment Request", - "examples": [ - { - "description": "This is the comment for the row", - "fk_model_id": "md_ehn5izr99m7d45", - "row_id": "3" - } - ], - "title": "Comment Request Model", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Description for the target row", - "example": "This is the comment for the row" - }, - "fk_model_id": { - "type": "string", - "description": "Foreign Key to Model", - "example": "md_ehn5izr99m7d45" - }, - "row_id": { - "type": "string", - "description": "Row ID", - "example": "3" - } - }, - "required": ["fk_model_id", "row_id"], - "x-stoplight": { - "id": "7nwlyinuliuvy" - } - }, - "CommentUpdateReq": { - "description": "Model for Comment Update Request", - "x-stoplight": { - "id": "r0f3ng2rahe38" - }, - "examples": [ - { - "description": "This is the comment for the row" - } - ], - "title": "Comment Update Request Model", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Description for the target row", - "example": "This is the comment for the row" - } - } - }, - "Filter": { - "description": "Model for Filter", - "examples": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "comparison_op": "eq", - "comparison_sub_op": null, - "created_at": "2023-03-02 18:18:05", - "fk_column_id": "cl_d7ah9n2qfupgys", - "fk_hook_id": null, - "fk_parent_id": null, - "fk_view_id": "vw_b739e29vqmrxnf", - "id": "fi_xn647tpmdq8fu8", - "is_group": null, - "logical_op": "and", - "order": 1, - "project_id": "p_xm3thidrblw4n7", - "updated_at": "2023-03-02 18:18:05", - "value": "foo" - } - ], - "properties": { - "base_id": { - "description": "Unqiue Base ID", - "readOnly": true, - "type": "string" - }, - "children": { - "description": "Children filters. Available when the filter is grouped.", - "items": { - "$ref": "#/components/schemas/Filter" - }, - "type": "array" - }, - "comparison_op": { - "description": "Comparison Operator", - "enum": [ - "allof", - "anyof", - "blank", - "btw", - "checked", - "empty", - "eq", - "ge", - "gt", - "gte", - "in", - "is", - "isWithin", - "isnot", - "le", - "like", - "lt", - "lte", - "nallof", - "nanyof", - "nbtw", - "neq", - "nlike", - "not", - "notblank", - "notchecked", - "notempty", - "notnull", - "null" - ], - "type": "string" - }, - "comparison_sub_op": { - "anyOf": [ - { - "enum": [ - "daysAgo", - "daysFromNow", - "exactDate", - "nextMonth", - "nextNumberOfDays", - "nextWeek", - "nextYear", - "oneMonthAgo", - "oneMonthFromNow", - "oneWeekAgo", - "oneWeekFromNow", - "pastMonth", - "pastNumberOfDays", - "pastWeek", - "pastYear", - "today", - "tomorrow", - "yesterday" - ], - "type": "string" - }, - { - "type": "null" - } - ], - "description": "Comparison Sub-Operator" - }, - "fk_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Column" - }, - "fk_hook_id": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Foreign Key to Hook" - }, - "fk_model_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Model" - }, - "fk_parent_id": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Foreign Key to parent group." - }, - "fk_view_id": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Foreign Key to View" - }, - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "is_group": { - "description": "Is this filter grouped?", - "oneOf": [ - { - "type": "boolean" - }, - { - "type": "integer" - }, - { - "type": "null" - } - ] - }, - "logical_op": { - "description": "Logical Operator", - "enum": ["and", "not", "or"], - "type": "string" - }, - "project_id": { - "description": "Unique Project ID", - "readOnly": true, - "type": "string" - }, - "value": { - "description": "The filter value. Can be NULL for some operators." - } - }, - "readOnly": true, - "title": "Filter Model", - "type": "object", - "x-stoplight": { - "id": "f8vsb8alix01i" - } - }, - "FilterList": { - "description": "Model for Filter List", - "examples": [ - { - "list": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "comparison_op": "eq", - "comparison_sub_op": null, - "created_at": "2023-03-02 18:18:05", - "fk_column_id": "cl_d7ah9n2qfupgys", - "fk_hook_id": null, - "fk_parent_id": null, - "fk_view_id": "vw_b739e29vqmrxnf", - "id": "fi_xn647tpmdq8fu8", - "is_group": null, - "logical_op": "and", - "order": 1, - "project_id": "p_xm3thidrblw4n7", - "updated_at": "2023-03-02 18:18:05", - "value": "foo" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - ], - "title": "Filter List Model", - "type": "object", - "x-examples": { - "example-1": { - "bases": { - "list": [ - { - "alias": "string", - "database": "string", - "host": "string", - "id": "string", - "params": "string", - "password": "string", - "port": 0, - "project_id": "string", - "ssl": "string", - "type": "string", - "url": "string", - "username": "string" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "pageSize": 0, - "sort": "string", - "totalRows": 0 - } - } - } - }, - "properties": { - "list": { - "type": "array", - "x-stoplight": { - "id": "22sgv37ve9kxo" - }, - "description": "List of filter objects", - "items": { - "$ref": "#/components/schemas/Filter", - "x-stoplight": { - "id": "ttw5rxhy83k8p" - } - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated", - "x-stoplight": { - "id": "7cyrb1770mrzz" - } - } - }, - "required": ["list", "pageInfo"], - "x-stoplight": { - "id": "mfxg43iomcoue" - } - }, - "FilterLogList": { - "description": "Model for Filter Log List", - "x-stoplight": { - "id": "0voe9zdizy5qd" - }, - "examples": [ - { - "list": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "comparison_op": "eq", - "comparison_sub_op": null, - "created_at": "2023-03-02 18:18:05", - "fk_column_id": "cl_d7ah9n2qfupgys", - "fk_hook_id": null, - "fk_parent_id": null, - "fk_view_id": "vw_b739e29vqmrxnf", - "id": "fi_xn647tpmdq8fu8", - "is_group": null, - "logical_op": "and", - "order": 1, - "project_id": "p_xm3thidrblw4n7", - "updated_at": "2023-03-02 18:18:05", - "value": "foo" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - ], - "title": "Filter Log List Model", - "type": "object", - "x-examples": { - "example-1": { - "bases": { - "list": [ - { - "alias": "string", - "database": "string", - "host": "string", - "id": "string", - "params": "string", - "password": "string", - "port": 0, - "project_id": "string", - "ssl": "string", - "type": "string", - "url": "string", - "username": "string" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "pageSize": 0, - "sort": "string", - "totalRows": 0 - } - } - } - }, - "properties": { - "list": { - "type": "array", - "x-stoplight": { - "id": "22sgv37ve9kxo" - }, - "description": "List of filter objects", - "items": { - "$ref": "#/components/schemas/Filter", - "x-stoplight": { - "id": "ttw5rxhy83k8p" - } - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated", - "x-stoplight": { - "id": "7cyrb1770mrzz" - } - } - }, - "required": ["list", "pageInfo"] - }, - "FilterReq": { - "description": "Model for Filter Request", - "examples": [ - { - "comparison_op": "eq", - "comparison_sub_op": null, - "fk_column_id": "cl_d7ah9n2qfupgys", - "is_group": false, - "logical_op": "and", - "value": "foo" - } - ], - "title": "Filter Request Model", - "type": "object", - "x-stoplight": { - "id": "pugjn1hobswqf" - }, - "properties": { - "comparison_op": { - "description": "Comparison Operator", - "enum": [ - "allof", - "anyof", - "blank", - "btw", - "checked", - "empty", - "eq", - "ge", - "gt", - "gte", - "in", - "is", - "isWithin", - "isnot", - "le", - "like", - "lt", - "lte", - "nallof", - "nanyof", - "nbtw", - "neq", - "nlike", - "not", - "notblank", - "notchecked", - "notempty", - "notnull", - "null" - ], - "type": "string" - }, - "comparison_sub_op": { - "anyOf": [ - { - "enum": [ - "daysAgo", - "daysFromNow", - "exactDate", - "nextMonth", - "nextNumberOfDays", - "nextWeek", - "nextYear", - "oneMonthAgo", - "oneMonthFromNow", - "oneWeekAgo", - "oneWeekFromNow", - "pastMonth", - "pastNumberOfDays", - "pastWeek", - "pastYear", - "today", - "tomorrow", - "yesterday" - ], - "type": "string" - }, - { - "type": "null" - } - ], - "description": "Comparison Sub-Operator" - }, - "fk_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Column" - }, - "fk_parent_id": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Belong to which filter ID" - }, - "is_group": { - "$ref": "#/components/schemas/Bool", - "description": "Is this filter grouped?" - }, - "logical_op": { - "description": "Logical Operator", - "enum": ["and", "not", "or"], - "type": "string" - }, - "value": { - "description": "The filter value. Can be NULL for some operators." - } - }, - "readOnly": true - }, - "Form": { - "description": "Model for Form", - "examples": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "banner_image_url": null, - "columns": [ - { - "id": "fvc_ugj9zo5bzocxtl", - "base_id": "ds_g4ccx6e77h1dmi", - "project_id": "p_xm3thidrblw4n7", - "fk_view_id": "vw_kdf5cr7qmhksek", - "fk_column_id": "cl_phvuuwjrzcdo0g", - "uuid": null, - "label": null, - "help": null, - "description": null, - "required": null, - "show": 0, - "order": 1, - "created_at": "2023-03-04 16:40:47", - "updated_at": "2023-03-04 16:40:47", - "meta": {} - } - ], - "email": "user@example.com", - "fk_model_id": "md_rsu68aqjsbyqtl", - "heading": "My Form", - "lock_type": "collaborative", - "logo_url": null, - "meta": null, - "redirect_after_secs": null, - "redirect_url": null, - "show_blank_form": 0, - "subheading": "My Form Subheading", - "submit_another_form": 0, - "success_msg": "Thank you for the submission.", - "title": "Form View 1" - } - ], - "title": "Form Model", - "type": "object", - "properties": { - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID", - "x-stoplight": { - "id": "z6wjvs00d3qfk" - } - }, - "banner_image_url": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Banner Image URL. Not in use currently." - }, - "columns": { - "type": "array", - "description": "Form Columns", - "items": { - "$ref": "#/components/schemas/FormColumn" - } - }, - "email": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Email to sned after form is submitted" - }, - "fk_model_id": { - "type": "string", - "description": "Foreign Key to Model", - "example": "md_rsu68aqjsbyqtl" - }, - "base_id": { - "type": "string", - "description": "Base ID", - "example": "md_rsu68aqjsbyqtl", - "x-stoplight": { - "id": "kfz7tve8nzj6f" - } - }, - "heading": { - "type": "string", - "description": "The heading of the form", - "example": "My Form" - }, - "lock_type": { - "enum": ["collaborative", "locked", "personal"], - "type": "string", - "description": "Lock Type of this view", - "example": "collaborative" - }, - "logo_url": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Logo URL. Not in use currently." - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "description": "Meta Info for this view" - }, - "redirect_after_secs": { - "$ref": "#/components/schemas/StringOrNull", - "description": "The numbers of seconds to redirect after form submission" - }, - "redirect_url": { - "$ref": "#/components/schemas/StringOrNull", - "description": "URL to redirect after submission" - }, - "show_blank_form": { - "$ref": "#/components/schemas/Bool", - "description": "Show `Blank Form` after 5 seconds" - }, - "subheading": { - "type": "string", - "description": "The subheading of the form", - "example": "My Form Subheading" - }, - "submit_another_form": { - "$ref": "#/components/schemas/Bool", - "description": "Show `Submit Another Form` button" - }, - "success_msg": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Custom message after the form is successfully submitted" - }, - "title": { - "type": "string", - "description": "Form View Title", - "example": "Form View 1" - } - }, - "x-stoplight": { - "id": "918aga51qb7w1" - } - }, - "FormUpdateReq": { - "description": "Model for Form Update Request", - "examples": [ - { - "banner_image_url": null, - "email": "user@example.com", - "heading": "My Form", - "logo_url": null, - "meta": null, - "redirect_after_secs": null, - "redirect_url": null, - "show_blank_form": 0, - "subheading": "My Form Subheading", - "submit_another_form": 0, - "success_msg": "Thank you for the submission." - } - ], - "title": "Form Update Request Model", - "type": "object", - "properties": { - "banner_image_url": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Banner Image URL. Not in use currently." - }, - "email": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Email to sned after form is submitted" - }, - "heading": { - "description": "The heading of the form", - "example": "My Form", - "maxLength": 255, - "type": "string" - }, - "logo_url": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Logo URL. Not in use currently." - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "description": "Meta Info for this view" - }, - "redirect_after_secs": { - "$ref": "#/components/schemas/StringOrNull", - "description": "The numbers of seconds to redirect after form submission" - }, - "redirect_url": { - "$ref": "#/components/schemas/StringOrNull", - "description": "URL to redirect after submission" - }, - "show_blank_form": { - "$ref": "#/components/schemas/Bool", - "description": "Show `Blank Form` after 5 seconds" - }, - "subheading": { - "$ref": "#/components/schemas/StringOrNull", - "description": "The subheading of the form" - }, - "submit_another_form": { - "$ref": "#/components/schemas/Bool", - "description": "Show `Submit Another Form` button" - }, - "success_msg": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Custom message after the form is successfully submitted" - } - }, - "x-stoplight": { - "id": "zn4juts75pksq" - } - }, - "FormColumn": { - "description": "Model for Form Column", - "examples": [ - { - "id": "fvc_1m9b0aub791d4m", - "description": null, - "fk_column_id": "cl_ah9zavkn25ihyd", - "fk_view_id": "vw_6fqln9vdytdv8q", - "help": "This is a help text", - "label": "Form Label", - "meta": null, - "order": 1, - "required": 0, - "show": 0, - "uuid": null - } - ], - "title": "Form Column Model", - "type": "object", - "x-examples": { - "example-1": { - "_cn": "first_name", - "alias": "first_name", - "created_at": "2022-02-15 12:39:04", - "description": "dsdsdsdsd", - "fk_column_id": "cl_yvyhsl9u81tokc", - "fk_view_id": "vw_s1pf4umdnikoyn", - "help": null, - "id": "fvc_8z1i7t8aswkqxx", - "label": "dsdsds", - "order": 1, - "required": false, - "show": 1, - "enable_scanner": true, - "updated_at": "2022-02-15 12:39:16", - "uuid": null - } - }, - "properties": { - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "description": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Form Column Description (Not in use)" - }, - "fk_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Column" - }, - "fk_view_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to View" - }, - "help": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Form Column Help Text" - }, - "label": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Form Column Label" - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "description": "Meta Info" - }, - "order": { - "type": "number", - "description": "The order among all the columns in the form", - "example": 1 - }, - "required": { - "$ref": "#/components/schemas/Bool", - "description": "Is this form column required in submission?" - }, - "show": { - "$ref": "#/components/schemas/Bool", - "description": "Is this column shown in Form?" - }, - "enable_scanner": { - "$ref": "#/components/schemas/Bool", - "description": "Indicates whether the 'Fill by scan' button is visible for this column or not.", - "example": true - }, - "uuid": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Form Column UUID (Not in use)" - } - }, - "x-stoplight": { - "id": "gm46pinkspvrz" - } - }, - "FormColumnReq": { - "description": "Model for Form Column Request", - "examples": [ - { - "description": null, - "help": "This is a help text", - "label": "Form Label", - "meta": null, - "order": 1, - "required": 0, - "show": 0 - } - ], - "title": "Form Column Request Model", - "type": "object", - "x-examples": { - "example-1": { - "_cn": "first_name", - "alias": "first_name", - "created_at": "2022-02-15 12:39:04", - "description": "dsdsdsdsd", - "fk_column_id": "cl_yvyhsl9u81tokc", - "fk_view_id": "vw_s1pf4umdnikoyn", - "help": null, - "id": "fvc_8z1i7t8aswkqxx", - "label": "dsdsds", - "order": 1, - "required": false, - "show": 1, - "updated_at": "2022-02-15 12:39:16", - "uuid": null - } - }, - "properties": { - "description": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Form Column Description (Not in use)" - }, - "help": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Form Column Help Text" - }, - "label": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Form Column Label" - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "description": "Meta Info" - }, - "order": { - "type": "number", - "description": "The order among all the columns in the form" - }, - "required": { - "$ref": "#/components/schemas/Bool", - "description": "Is this form column required in submission?" - }, - "show": { - "$ref": "#/components/schemas/Bool", - "description": "Is this column shown in Form?" - } - }, - "x-stoplight": { - "id": "nmffmb1p3wkg9" - } - }, - "Formula": { - "description": "Model for Formula", - "examples": [ - { - "id": "fm_1lo8wqtvvipdns", - "fk_column_id": "cl_h2micb4jdnmsh1", - "formula": "CONCAT(\"FOO\", {{cl_c5knoi4xs4sfpt}})", - "formula_raw": "CONCAT(\"FOO\", {Title})", - "error": "Error Message shows here" - } - ], - "title": "Formula Model", - "type": "object", - "properties": { - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "fk_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Column" - }, - "formula": { - "type": "string", - "description": "Formula with column ID replaced", - "example": "CONCAT(\"FOO\", {{cl_c5knoi4xs4sfpt}})" - }, - "formula_raw": { - "type": "string", - "description": "Original Formula inputted in UI", - "example": "CONCAT(\"FOO\", {Title})" - }, - "error": { - "type": "string", - "description": "Error Message" - } - }, - "x-stoplight": { - "id": "hlu7yokpavxwb" - } - }, - "FormulaColumnReq": { - "description": "Model for Formula Column Request", - "examples": [ - { - "formula": "CONCAT(\"FOO\", {{cl_c5knoi4xs4sfpt}})", - "formula_raw": "CONCAT(\"FOO\", {Title})", - "title": "Formula", - "uidt": "Formula" - } - ], - "title": "Formula Column Request Model", - "type": "object", - "properties": { - "formula": { - "type": "string", - "description": "Formula with column ID replaced" - }, - "formula_raw": { - "type": "string", - "description": "Original Formula inputted in UI" - }, - "title": { - "maxLength": 255, - "minLength": 1, - "type": "string", - "description": "Formula Title" - }, - "uidt": { - "enum": ["Formula"], - "type": "string", - "description": "UI Data Type" - } - }, - "x-stoplight": { - "id": "v26r0c9hlimtv" - } - }, - "Gallery": { - "description": "Model for Gallery", - "examples": [ - { - "alias": "string", - "columns": [ - { - "fk_col_id": "string", - "fk_gallery_id": "string", - "help": "string", - "id": "string", - "label": "string" - } - ], - "cover_image": "string", - "cover_image_idx": 0, - "deleted": true, - "fk_cover_image_col_id": "string", - "fk_model_id": "string", - "fk_view_id": "string", - "lock_type": "collaborative", - "next_enabled": true, - "order": 0, - "prev_enabled": true, - "restrict_number": "string", - "restrict_size": "string", - "restrict_types": "string", - "title": "string" - } - ], - "properties": { - "alias": { - "type": "string" - }, - "columns": { - "items": { - "$ref": "#/components/schemas/GalleryColumn" - }, - "type": "array" - }, - "cover_image": { - "type": "string" - }, - "cover_image_idx": { - "type": "integer" - }, - "deleted": { - "$ref": "#/components/schemas/Bool" - }, - "fk_cover_image_col_id": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Foreign Key to Cover Image Column" - }, - "fk_model_id": { - "type": "string", - "description": "Foreign Key to Model" - }, - "fk_view_id": { - "type": "string", - "description": "Foreign Key to View" - }, - "lock_type": { - "enum": ["collaborative", "locked", "personal"], - "type": "string" - }, - "next_enabled": { - "$ref": "#/components/schemas/Bool" - }, - "order": { - "type": "number", - "description": "Order of Gallery" - }, - "prev_enabled": { - "$ref": "#/components/schemas/Bool" - }, - "restrict_number": { - "type": "string" - }, - "restrict_size": { - "type": "string" - }, - "restrict_types": { - "type": "string" - }, - "title": { - "type": "string" - } - }, - "title": "Gallery Model", - "type": "object", - "x-stoplight": { - "id": "i0h7av37o4eks" - } - }, - "GalleryColumn": { - "description": "Model for Gallery Column", - "examples": [ - { - "fk_col_id": "string", - "fk_gallery_id": "string", - "help": "string", - "id": "string", - "label": "string" - } - ], - "properties": { - "fk_col_id": { - "type": "string" - }, - "fk_gallery_id": { - "type": "string" - }, - "help": { - "type": "string" - }, - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "label": { - "type": "string" - } - }, - "title": "Gallery Column Model", - "type": "object", - "x-stoplight": { - "id": "jdhvl7gb33fqo" - } - }, - "GalleryUpdateReq": { - "description": "Model for Gallery View Update Request", - "x-stoplight": { - "id": "x57k1fq4101e1" - }, - "examples": [ - { - "fk_cover_image_col_id": "cl_ib8l4j1kiu1efx", - "meta": null - } - ], - "title": "Gallery View Update Request Model", - "type": "object", - "properties": { - "fk_cover_image_col_id": { - "$ref": "#/components/schemas/StringOrNull", - "description": "The id of the column that contains the cover image" - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "x-stoplight": { - "id": "zhp6jkrr54wuf" - }, - "description": "Meta Info" - } - } - }, - "GeoLocation": { - "description": "Model for Geo Location", - "examples": [ - { - "latitude": 18.52139, - "longitude": 179.87295 - } - ], - "properties": { - "latitude": { - "description": "The latitude of the location", - "example": 18.52139, - "exclusiveMaximum": 90, - "exclusiveMinimum": -90, - "format": "double", - "type": "number" - }, - "longitude": { - "description": "The longitude of the location", - "example": 179.87295, - "exclusiveMaximum": 180, - "exclusiveMinimum": -180, - "format": "double", - "type": "number" - } - }, - "title": "Geo Location Model", - "type": "object", - "x-stoplight": { - "id": "685e1l91iuxhv" - } - }, - "Grid": { - "description": "Model for Grid", - "examples": [ - { - "project_id": "p_xm3thidrblw4n7", - "base_id": "ds_g4ccx6e77h1dmi", - "fk_view_id": "vw_p2jcatxz4mvcfw", - "row_height": 1, - "meta": null, - "columns": [ - { - "id": "cl_phvuuwjrzcdo0g", - "base_id": "ds_g4ccx6e77h1dmi", - "project_id": "p_xm3thidrblw4n7", - "fk_model_id": "md_rsu68aqjsbyqtl", - "title": "Id", - "column_name": "id", - "uidt": "ID", - "dt": "int", - "np": "10", - "ns": "0", - "clen": null, - "cop": "1", - "pk": 1, - "pv": null, - "rqd": 1, - "un": 1, - "ct": "int unsigned", - "ai": 1, - "unique": 0, - "cdf": null, - "cc": "", - "csn": null, - "dtx": "specificType", - "dtxp": "", - "dtxs": "0", - "au": 0, - "validate": null, - "virtual": null, - "deleted": null, - "system": 0, - "order": 1, - "created_at": "2023-03-02 17:04:06", - "updated_at": "2023-03-02 17:04:06", - "meta": null - } - ] - } - ], - "title": "Grid Model", - "type": "object", - "properties": { - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID", - "x-stoplight": { - "id": "e3ti3fc0ocjyu" - } - }, - "project_id": { - "$ref": "#/components/schemas/Id", - "description": "Project ID", - "x-stoplight": { - "id": "e3ti3fc0ocjyu" - } - }, - "base_id": { - "$ref": "#/components/schemas/Id", - "description": "Base ID", - "x-stoplight": { - "id": "m8v3iyf1tidy9" - } - }, - "fk_view_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to View", - "x-stoplight": { - "id": "m8v3iyf1tidy9" - } - }, - "row_height": { - "type": "number", - "example": 1, - "description": "Row Height" - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "x-stoplight": { - "id": "n8cud3jyqw5yv" - }, - "description": "Meta info for Grid Model" - }, - "columns": { - "type": "array", - "x-stoplight": { - "id": "22y0gipx2jdf8" - }, - "description": "Grid View Columns", - "items": { - "$ref": "#/components/schemas/GridColumn", - "x-stoplight": { - "id": "nmzp6w3o6b24u" - } - } - } - }, - "x-stoplight": { - "id": "1xswddf91q5pu" - } - }, - "Grid - copy": { - "description": "Model for Grid", - "x-stoplight": { - "id": "xheueli0578g0" - }, - "examples": [ - { - "project_id": "p_xm3thidrblw4n7", - "base_id": "ds_g4ccx6e77h1dmi", - "fk_view_id": "vw_p2jcatxz4mvcfw", - "row_height": 1, - "meta": null, - "columns": [ - { - "id": "cl_phvuuwjrzcdo0g", - "base_id": "ds_g4ccx6e77h1dmi", - "project_id": "p_xm3thidrblw4n7", - "fk_model_id": "md_rsu68aqjsbyqtl", - "title": "Id", - "column_name": "id", - "uidt": "ID", - "dt": "int", - "np": "10", - "ns": "0", - "clen": null, - "cop": "1", - "pk": 1, - "pv": null, - "rqd": 1, - "un": 1, - "ct": "int unsigned", - "ai": 1, - "unique": 0, - "cdf": null, - "cc": "", - "csn": null, - "dtx": "specificType", - "dtxp": "", - "dtxs": "0", - "au": 0, - "validate": null, - "virtual": null, - "deleted": null, - "system": 0, - "order": 1, - "created_at": "2023-03-02 17:04:06", - "updated_at": "2023-03-02 17:04:06", - "meta": null - } - ] - } - ], - "title": "Grid Model", - "type": "object", - "properties": { - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID", - "x-stoplight": { - "id": "e3ti3fc0ocjyu" - } - }, - "project_id": { - "$ref": "#/components/schemas/Id", - "description": "Project ID", - "x-stoplight": { - "id": "e3ti3fc0ocjyu" - } - }, - "base_id": { - "$ref": "#/components/schemas/Id", - "description": "Base ID", - "x-stoplight": { - "id": "m8v3iyf1tidy9" - } - }, - "fk_view_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to View", - "x-stoplight": { - "id": "m8v3iyf1tidy9" - } - }, - "row_height": { - "type": "number", - "example": 1, - "description": "Row Height" - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "x-stoplight": { - "id": "n8cud3jyqw5yv" - }, - "description": "Meta info for Grid Model" - }, - "columns": { - "type": "array", - "x-stoplight": { - "id": "22y0gipx2jdf8" - }, - "description": "Grid View Columns", - "items": { - "$ref": "#/components/schemas/GridColumn", - "x-stoplight": { - "id": "nmzp6w3o6b24u" - } - } - } - } - }, - "GridColumn": { - "description": "Model for Grid Column", - "examples": [ - { - "id": "nc_c8jz4kxe6xvh11", - "fk_view_id": "vw_p2jcatxz4mvcfw", - "fk_column_id": "cl_c5knoi4xs4sfpt", - "project_id": "p_xm3thidrblw4n7", - "base_id": "ds_g4ccx6e77h1dmi", - "show": 0, - "order": 1, - "width": "200px", - "help": null - } - ], - "title": "Grid Column Model", - "type": "object", - "properties": { - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID", - "x-stoplight": { - "id": "jc14yojp52rqj" - } - }, - "fk_view_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to View", - "x-stoplight": { - "id": "vl18dbt5c2r8r" - } - }, - "fk_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Column", - "x-stoplight": { - "id": "2drg88fmodf3v" - } - }, - "project_id": { - "$ref": "#/components/schemas/Id", - "description": "Project ID", - "x-stoplight": { - "id": "2drg88fmodf3v" - } - }, - "base_id": { - "$ref": "#/components/schemas/Id", - "description": "Base ID", - "x-stoplight": { - "id": "2drg88fmodf3v" - } - }, - "show": { - "$ref": "#/components/schemas/Bool", - "x-stoplight": { - "id": "d47eer13oa8yr" - } - }, - "order": { - "type": "number", - "x-stoplight": { - "id": "d47eer13oa8yr" - }, - "example": 1, - "description": "Grid Column Order" - }, - "width": { - "type": "string", - "description": "Column Width", - "example": "200px" - }, - "help": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Column Help Text", - "x-stoplight": { - "id": "azwh6zn37qzkc" - } - } - }, - "x-stoplight": { - "id": "g06nri6t6h6ke" - } - }, - "GridColumnReq": { - "description": "Model for Grid Column Request", - "examples": [ - { - "fk_column_id": "cl_c5knoi4xs4sfpt", - "label": "My Column", - "width": "200px" - } - ], - "properties": { - "fk_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Column" - }, - "help": { - "maxLength": 255, - "type": "string" - }, - "label": { - "description": "The label of the column", - "example": "My Column", - "maxLength": 255, - "type": "string" - }, - "width": { - "description": "The width of the column", - "example": "200px", - "maxLength": 255, - "pattern": "^[0-9]+(px|%)$", - "type": "string" - } - }, - "title": "Grid Column Request Model", - "type": "object", - "x-stoplight": { - "id": "8v9cxve0332zg" - } - }, - "GridUpdateReq": { - "description": "Model for Grid View Update", - "x-stoplight": { - "id": "g10t5gray4bk5" - }, - "examples": [ - { - "row_height": "1", - "meta": null - } - ], - "title": "Grid View Update Model", - "type": "object", - "properties": { - "row_height": { - "type": "number", - "x-stoplight": { - "id": "m5976ax1q13cr" - }, - "description": "Row Height", - "example": 1 - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "x-stoplight": { - "id": "dugbkhe9iupqu" - }, - "description": "Meta Info for grid view" - } - } - }, - "Hook": { - "description": "Model for Hook", - "examples": [ - { - "active": 0, - "async": 0, - "description": "This is my hook description", - "env": "all", - "event": "after", - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "string", - "notification": "{\"type\":\"URL\",\"payload\":{\"method\":\"POST\",\"body\":\"{{ json data }}\",\"headers\":[{}],\"parameters\":[{}],\"auth\":\"\",\"path\":\"http://example.com\"}}", - "null": null, - "operation": "insert", - "retries": 10, - "retry_interval": 60000, - "timeout": 60000, - "title": "My Webhook" - } - ], - "title": "Hook Model", - "type": "object", - "x-stoplight": { - "id": "32blg2oqo6g7p" - }, - "properties": { - "active": { - "$ref": "#/components/schemas/Bool", - "description": "Is the hook active?" - }, - "async": { - "$ref": "#/components/schemas/Bool", - "description": "Is the hook aysnc?" - }, - "description": { - "type": "string", - "description": "Hook Description", - "example": "This is my hook description" - }, - "env": { - "type": "string", - "example": "all", - "description": "Environment for the hook" - }, - "event": { - "enum": ["after", "before"], - "type": "string", - "description": "Event Type for the operation", - "example": "after" - }, - "fk_model_id": { - "type": "string", - "description": "Foreign Key to Model", - "example": "md_rsu68aqjsbyqtl" - }, - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "notification": { - "description": "Hook Notification including info such as type, payload, method, body, and etc", - "type": ["object", "string"] - }, - "operation": { - "enum": [ - "insert", - "update", - "delete", - "bulkInsert", - "bulkUpdate", - "bulkDelete" - ], - "type": "string", - "description": "Hook Operation", - "example": "insert" - }, - "retries": { - "type": "number", - "description": "Retry Count", - "example": 10 - }, - "retry_interval": { - "type": "number", - "description": "Retry Interval", - "example": 60000 - }, - "timeout": { - "type": "number", - "example": 60000, - "description": "Timeout" - }, - "title": { - "type": "string", - "description": "Hook Title", - "example": "My Webhook" - }, - "type": { - "type": "string", - "description": "Hook Type" - }, - "version": { - "type": "string", - "x-stoplight": { - "id": "socewqvadj91n" - }, - "example": "v2", - "description": "Hook Version", - "enum": ["v1", "v2"] - } - } - }, - "HookReq": { - "description": "Model for Hook", - "x-stoplight": { - "id": "85vr8fx3oea31" - }, - "examples": [ - { - "active": 0, - "async": 0, - "description": "This is my hook description", - "env": "all", - "event": "after", - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "string", - "notification": "{\"type\":\"URL\",\"payload\":{\"method\":\"POST\",\"body\":\"{{ json data }}\",\"headers\":[{}],\"parameters\":[{}],\"auth\":\"\",\"path\":\"http://example.com\"}}", - "null": null, - "operation": "insert", - "retries": 10, - "retry_interval": 60000, - "timeout": 60000, - "title": "My Webhook", - "condition": false - } - ], - "title": "Hook Request Model", - "type": "object", - "properties": { - "active": { - "$ref": "#/components/schemas/Bool", - "description": "Is the hook active?" - }, - "async": { - "$ref": "#/components/schemas/Bool", - "description": "Is the hook aysnc?" - }, - "description": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Hook Description" - }, - "env": { - "type": "string", - "example": "all", - "description": "Environment for the hook" - }, - "event": { - "enum": ["after", "before"], - "type": "string", - "description": "Event Type for the operation", - "example": "after" - }, - "fk_model_id": { - "type": "string", - "description": "Foreign Key to Model", - "example": "md_rsu68aqjsbyqtl" - }, - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "notification": { - "description": "Hook Notification including info such as type, payload, method, body, and etc", - "type": ["object", "string"] - }, - "operation": { - "enum": [ - "insert", - "update", - "delete", - "bulkInsert", - "bulkUpdate", - "bulkDelete" - ], - "type": "string", - "description": "Hook Operation", - "example": "insert" - }, - "retries": { - "type": "number", - "description": "Retry Count", - "example": 10 - }, - "retry_interval": { - "type": "number", - "description": "Retry Interval", - "example": 60000 - }, - "timeout": { - "type": "number", - "example": 60000, - "description": "Timeout" - }, - "title": { - "type": "string", - "description": "Hook Title", - "example": "My Webhook" - }, - "type": { - "type": ["string", "null"], - "description": "Hook Type" - }, - "condition": { - "$ref": "#/components/schemas/Bool", - "x-stoplight": { - "id": "wwzoum7rrlwun" - }, - "description": "Is this hook assoicated with some filters" - } - }, - "required": ["event", "notification", "operation", "title"] - }, - "HookList": { - "description": "Model for Hook List", - "examples": [ - { - "list": [ - { - "active": 0, - "async": 0, - "description": "This is my hook description", - "env": "all", - "event": "after", - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "string", - "notification": "{\"type\":\"URL\",\"payload\":{\"method\":\"POST\",\"body\":\"{{ json data }}\",\"headers\":[{}],\"parameters\":[{}],\"auth\":\"\",\"path\":\"http://example.com\"}}", - "null": null, - "operation": "insert", - "retries": 10, - "retry_interval": 60000, - "timeout": 60000, - "title": "My Webhook" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - ], - "title": "Hook List Model", - "type": "object", - "x-examples": { - "example-1": { - "bases": { - "list": [ - { - "alias": "string", - "database": "string", - "host": "string", - "id": "string", - "params": "string", - "password": "string", - "port": 0, - "project_id": "string", - "ssl": "string", - "type": "string", - "url": "string", - "username": "string" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "pageSize": 0, - "sort": "string", - "totalRows": 0 - } - } - } - }, - "properties": { - "list": { - "minItems": 1, - "type": "array", - "uniqueItems": true, - "description": "List of hook objects", - "items": { - "$ref": "#/components/schemas/Hook" - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated" - } - }, - "required": ["list", "pageInfo"], - "x-stoplight": { - "id": "n2sbatqu55day" - } - }, - "HookLog": { - "description": "Model for Hook Log", - "examples": [ - { - "base_id": "ds_jxuewivwbxeum2", - "event": "after", - "execution_time": "98", - "fk_hook_id": "hk_035ijv5qdi97y5", - "id": "string", - "notifications": "{\"type\":\"URL\",\"payload\":{\"method\":\"POST\",\"body\":\"{{ json data }}\",\"headers\":[{}],\"parameters\":[{}],\"auth\":\"\",\"path\":\"https://webhook.site/6eb45ce5-b611-4be1-8b96-c2965755662b\"}}", - "operation": "insert", - "payload": "{\"method\":\"POST\",\"body\":\"{{ json data }}\",\"headers\":[{}],\"parameters\":[{}],\"auth\":\"\",\"path\":\"https://webhook.site/6eb45ce5-b611-4be1-8b96-c2965755662b\"}", - "project_id": "p_tbhl1hnycvhe5l", - "response": "{\"status\":200,\"statusText\":\"OK\",\"headers\":{\"server\":\"nginx\",\"content-type\":\"text/plain; charset=UTF-8\",\"transfer-encoding\":\"chunked\",\"connection\":\"close\",\"vary\":\"Accept-Encoding\",\"x-request-id\":\"53844a7d-ede8-4798-adf7-8af441908a72\",\"x-token-id\":\"6eb45ce5-b611-4be1-8b96-c2965755662b\",\"cache-control\":\"no-cache, private\",\"date\":\"Fri, 24 Mar 2023 10:50:10 GMT\"},\"config\":{\"url\":\"https://webhook.site/6eb45ce5-b611-4be1-8b96-c2965755662b\",\"method\":\"post\",\"data\":\"{\\\"type\\\":\\\"records.after.insert\\\",\\\"id\\\":\\\"a77d97dc-a3e4-4719-9b46-45f93e0cc99a\\\",\\\"data\\\":{\\\"table_id\\\":\\\"md_d8v403o74mf5lf\\\",\\\"table_name\\\":\\\"Sheet-2\\\"}}\",\"headers\":{\"Accept\":\"application/json, text/plain, */*\",\"Content-Type\":\"application/x-www-form-urlencoded\",\"User-Agent\":\"axios/0.21.4\",\"Content-Length\":138},\"params\":{}}}", - "test_call": 0, - "triggered_by": "w@nocodb.com", - "type": "URL" - } - ], - "title": "Hook Log Model", - "type": "object", - "x-stoplight": { - "id": "ni303795b18y5" - }, - "properties": { - "base_id": { - "type": "string", - "description": "Unique Base ID", - "example": "ds_jxuewivwbxeum2" - }, - "conditions": { - "type": "string", - "description": "Hook Conditions" - }, - "error": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Error" - }, - "error_code": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Error Code" - }, - "error_message": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Error Message" - }, - "event": { - "type": "string", - "description": "Hook Event", - "example": "after", - "enum": ["after", "before"] - }, - "execution_time": { - "type": "string", - "description": "Execution Time in milliseconds", - "example": "98" - }, - "fk_hook_id": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Foreign Key to Hook" - }, - "id": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Unique ID" - }, - "notifications": { - "type": "string", - "description": "Hook Notification" - }, - "operation": { - "type": "string", - "description": "Hook Operation", - "enum": [ - "insert", - "update", - "delete", - "bulkInsert", - "bulkUpdate", - "bulkDelete" - ], - "example": "insert" - }, - "payload": { - "type": "string", - "description": "Hook Payload", - "example": "{\"method\":\"POST\",\"body\":\"{{ json data }}\",\"headers\":[{}],\"parameters\":[{}],\"auth\":\"\",\"path\":\"https://webhook.site/6eb45ce5-b611-4be1-8b96-c2965755662b\"}" - }, - "project_id": { - "type": "string", - "description": "Project ID", - "example": "p_tbhl1hnycvhe5l" - }, - "response": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Hook Response" - }, - "test_call": { - "$ref": "#/components/schemas/Bool", - "description": "Is this testing hook call?" - }, - "triggered_by": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Who triggered the hook?" - }, - "type": { - "type": "string", - "example": "URL", - "description": "Hook Type" - } - } - }, - "HookLogList": { - "description": "Model for Hook Log List", - "x-stoplight": { - "id": "tfv7y629w2ap2" - }, - "examples": [], - "title": "Hook Log List Model", - "type": "object", - "x-examples": { - "example-1": { - "bases": { - "list": [ - { - "alias": "string", - "database": "string", - "host": "string", - "id": "string", - "params": "string", - "password": "string", - "port": 0, - "project_id": "string", - "ssl": "string", - "type": "string", - "url": "string", - "username": "string" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "pageSize": 0, - "sort": "string", - "totalRows": 0 - } - } - } - }, - "properties": { - "list": { - "minItems": 1, - "type": "array", - "uniqueItems": true, - "description": "List of hook objects", - "items": { - "$ref": "#/components/schemas/HookLog" - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated" - } - }, - "required": ["list", "pageInfo"] - }, - "HookTestReq": { - "description": "Model for Hook Test Request", - "examples": [ - { - "hook": { - "active": 0, - "async": 0, - "description": "This is my hook description", - "env": "all", - "event": "after", - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "string", - "notification": "{\"type\":\"URL\",\"payload\":{\"method\":\"POST\",\"body\":\"{{ json data }}\",\"headers\":[{}],\"parameters\":[{}],\"auth\":\"\",\"path\":\"http://example.com\"}}", - "null": null, - "operation": "insert", - "retries": 10, - "retry_interval": 60000, - "timeout": 60000, - "title": "My Webhook" - }, - "payload": { - "data": { - "Id": 1, - "Title": "Sample Text", - "CreatedAt": "2023-03-03T10:03:06.484Z", - "UpdatedAt": "2023-03-03T10:03:06.484Z", - "attachment": [ - { - "url": "https://nocodb.com/dummy.png", - "title": "image.png", - "mimetype": "image/png", - "size": 0 - } - ], - "f": "Sample Output" - } - } - } - ], - "title": "Hook Test Request Model", - "type": "object", - "properties": { - "hook": { - "$ref": "#/components/schemas/HookReq" - }, - "payload": { - "description": "Payload to be sent" - } - }, - "required": ["hook", "payload"], - "x-stoplight": { - "id": "w64q11jiv01np" - } - }, - "Id": { - "description": "Model for ID", - "examples": ["string"], - "maxLength": 20, - "minLength": 0, - "title": "ID Model", - "type": "string", - "x-stoplight": { - "id": "obj8r7jhyfoqg" - } - }, - "Kanban": { - "description": "Model for Kanban", - "examples": [ - { - "id": "vw_wqs4zheuo5lgdy", - "fk_grp_col_id": "cl_3704cxcbqt7sj7", - "fk_view_id": "vw_wqs4zheuo5lgdy", - "fk_cover_image_col_id": null, - "columns": [ - { - "id": "kvc_2skkg5mi1eb37f", - "fk_column_id": "cl_hzos4ghyncqi4k", - "fk_view_id": "vw_wqs4zheuo5lgdy", - "base_id": "ds_hd4ojj0xpquaam", - "project_id": "p_kzfl5lb0t3tcok", - "title": "string", - "show": 0, - "order": "1" - } - ], - "meta": null, - "title": "My Kanban" - } - ], - "title": "Kanban Model", - "type": "object", - "properties": { - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "fk_grp_col_id": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Grouping Field Column ID" - }, - "fk_view_id": { - "$ref": "#/components/schemas/Id", - "x-stoplight": { - "id": "1kgw1w06b97nl" - }, - "description": "View ID" - }, - "fk_cover_image_col_id": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Cover Image Column ID" - }, - "columns": { - "type": "array", - "description": "Kanban Columns", - "items": { - "$ref": "#/components/schemas/KanbanColumn" - } - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "description": "Meta Info for Kanban" - }, - "title": { - "type": "string", - "description": "Kanban Title", - "example": "My Kanban" - } - }, - "x-stoplight": { - "id": "sfbbvgbcv7je6" - } - }, - "KanbanColumn": { - "description": "Model for Kanban Column", - "examples": [ - { - "id": "kvc_2skkg5mi1eb37f", - "fk_column_id": "cl_hzos4ghyncqi4k", - "fk_view_id": "vw_wqs4zheuo5lgdy", - "base_id": "ds_hd4ojj0xpquaam", - "project_id": "p_kzfl5lb0t3tcok", - "title": "string", - "show": 0, - "order": "1" - } - ], - "title": "Kanban Column Model", - "type": "object", - "properties": { - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "fk_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Column" - }, - "fk_view_id": { - "$ref": "#/components/schemas/Id", - "x-stoplight": { - "id": "t1fy4zy561ih8" - }, - "description": "Foreign Key to View" - }, - "base_id": { - "$ref": "#/components/schemas/Id", - "x-stoplight": { - "id": "uqq8xmyz97t1u" - }, - "description": "Baes ID\n" - }, - "project_id": { - "$ref": "#/components/schemas/Id", - "x-stoplight": { - "id": "uqq8xmyz97t1u" - }, - "description": "Project ID" - }, - "title": { - "x-stoplight": { - "id": "uqq8xmyz97t1u" - }, - "description": "Project ID", - "type": "string" - }, - "show": { - "$ref": "#/components/schemas/Bool", - "x-stoplight": { - "id": "uqq8xmyz97t1u" - }, - "description": "Is this column shown?" - }, - "order": { - "type": "number", - "x-stoplight": { - "id": "pbnchzgci5dwa" - }, - "example": 1, - "description": "Column Order" - } - }, - "x-stoplight": { - "id": "epfedw9ccxgxe" - } - }, - "KanbanUpdateReq": { - "description": "Model for Kanban Update Request", - "examples": [ - { - "fk_grp_col_id": "cl_g0a89q9xdry3lu", - "fk_cover_image_col_id": "cl_ib8l4j1kiu1efx", - "meta": { - "cl_g0a89q9xdry3lu": [ - { - "id": "uncategorized", - "title": null, - "order": 0, - "color": "#c2f5e8", - "collapsed": false - }, - { - "id": "sl_ihyva6jx6dg0fc", - "fk_column_id": "cl_g0a89q9xdry3lu", - "title": "a", - "color": "#cfdffe", - "order": 1, - "collapsed": false - }, - { - "id": "sl_gqdm5v6t8aetoa", - "fk_column_id": "cl_g0a89q9xdry3lu", - "title": "b", - "color": "#d0f1fd", - "order": 2, - "collapsed": false - }, - { - "id": "sl_eipnl0kn7a9d3c", - "fk_column_id": "cl_g0a89q9xdry3lu", - "title": "cc", - "color": "#c2f5e8", - "order": 3, - "collapsed": false - }, - { - "id": "sl_dei8p2jq0cnlv0", - "fk_column_id": "cl_g0a89q9xdry3lu", - "title": "d", - "color": "#ffdaf6", - "order": 4, - "collapsed": false - } - ] - } - } - ], - "title": "Kanban Update Request Model", - "type": "object", - "properties": { - "fk_grp_col_id": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Foreign Key to Grouping Field Column" - }, - "fk_cover_image_col_id": { - "$ref": "#/components/schemas/StringOrNull", - "x-stoplight": { - "id": "81wn4hzj76wod" - }, - "description": "Foreign Key to Cover Image Column" - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "x-stoplight": { - "id": "stsvdmkli1b0r" - }, - "description": "Meta Info" - } - }, - "x-stoplight": { - "id": "b1jlyk12kfuwx" - } - }, - "LicenseReq": { - "description": "Model for Kanban Request", - "examples": [ - { - "key": "1234567890" - } - ], - "properties": { - "key": { - "description": "The license key", - "example": "1234567890", - "maxLength": 255, - "minLength": 10, - "type": "string" - } - }, - "title": "License Key Request Model", - "type": "object", - "x-stoplight": { - "id": "trgk6qlmgdyfo" - } - }, - "LinkToAnotherColumnReq": { - "description": "Model for LinkToAnotherColumn Request", - "examples": [ - { - "childId": "string", - "parentId": "string", - "title": "string", - "type": "hm", - "uidt": "LinkToAnotherRecord", - "virtual": true - } - ], - "properties": { - "childId": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to chhild column" - }, - "parentId": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to parent column" - }, - "title": { - "maxLength": 255, - "minLength": 1, - "type": "string", - "description": "The title of the virtual column" - }, - "type": { - "enum": ["bt", "hm", "mm"], - "type": "string", - "description": "The type of the relationship" - }, - "uidt": { - "enum": ["LinkToAnotherRecord"], - "type": "string", - "description": "Abstract type of the relationship" - }, - "virtual": { - "$ref": "#/components/schemas/Bool", - "description": "Is this relationship virtual?" - } - }, - "required": ["childId", "parentId", "title", "type", "uidt"], - "title": "LinkToAnotherColumn Request Model", - "type": "object", - "x-stoplight": { - "id": "x59gz5reg12x3" - } - }, - "LinkToAnotherRecord": { - "description": "Model for LinkToAnotherRecord", - "examples": [ - { - "deleted": "string", - "dr": "string", - "fk_child_column_id": "string", - "fk_column_id": "string", - "fk_index_name": "string", - "fk_mm_child_column_id": "string", - "fk_mm_model_id": "string", - "fk_mm_parent_column_id": "string", - "fk_parent_column_id": "string", - "fk_related_model_id": "string", - "id": "string", - "order": "string", - "type": "string", - "ur": "string", - "virtual": true - } - ], - "properties": { - "deleted": { - "type": "string" - }, - "dr": { - "type": "string" - }, - "fk_child_column_id": { - "type": "string" - }, - "fk_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Column" - }, - "fk_index_name": { - "type": "string" - }, - "fk_mm_child_column_id": { - "type": "string" - }, - "fk_mm_model_id": { - "type": "string" - }, - "fk_mm_parent_column_id": { - "type": "string" - }, - "fk_parent_column_id": { - "type": "string" - }, - "fk_related_model_id": { - "type": "string" - }, - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "order": { - "type": "string" - }, - "type": { - "type": "string" - }, - "ur": { - "type": "string" - }, - "virtual": { - "$ref": "#/components/schemas/Bool" - } - }, - "title": "LinkToAnotherRecord Model", - "type": "object", - "x-stoplight": { - "id": "27q0vnr79hxla" - } - }, - "Lookup": { - "description": "Model for Lookup", - "examples": [ - { - "id": "lk_mngsu0e45njbxr", - "fk_column_id": "cl_vdiy9bz7h11kdm", - "fk_relation_column_id": "cl_5jestblzneb649", - "fk_lookup_column_id": "cl_4cm47dtjphgqkv", - "order": 1 - } - ], - "title": "Lookup Model", - "type": "object", - "properties": { - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "fk_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Column" - }, - "fk_lookup_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Lookup Column" - }, - "fk_relation_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Relation Column" - }, - "order": { - "type": "number", - "description": "The order among the list", - "example": 1 - } - }, - "x-stoplight": { - "id": "guyozhka8sx1t" - } - }, - "LookupColumnReq": { - "description": "Model for Lookup Column Request", - "examples": [ - { - "fk_relation_column_id": "cl_5jestblzneb649", - "fk_lookup_column_id": "cl_4cm47dtjphgqkv", - "title": "My Lookup", - "uidt": "Lookup" - } - ], - "title": "Lookup Column Request Model", - "type": "object", - "properties": { - "fk_lookup_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Lookup Column" - }, - "fk_relation_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Relation Column" - }, - "title": { - "maxLength": 255, - "type": "string", - "description": "Lookup Title", - "example": "My Lookup" - }, - "uidt": { - "enum": ["Lookup"], - "type": "string", - "description": "UI DataType" - } - }, - "x-stoplight": { - "id": "hmeckhq2ciwpf" - } - }, - "Map": { - "description": "Model for Map", - "examples": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "columns": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "fk_column_id": "cl_8iw2o4ejzvdyna", - "fk_view_id": "vw_qjt7klod1p9kyv", - "id": "nc_46xcacqn4rc9xf", - "order": 1, - "project_id": "p_xm3thidrblw4n7", - "show": 1 - } - ], - "fk_geo_data_col_id": "cl_8iw2o4ejzvdyna", - "fk_view_id": "vw_qjt7klod1p9kyv", - "meta": {}, - "order": 0, - "project_id": "p_xm3thidrblw4n7", - "show": true, - "title": "My Map" - } - ], - "properties": { - "base_id": { - "description": "The ID of the base that this view belongs to", - "example": "ds_g4ccx6e77h1dmi", - "type": "string" - }, - "columns": { - "description": "Columns in this view", - "items": { - "$ref": "#/components/schemas/MapColumn" - }, - "type": "array" - }, - "fk_geo_data_col_id": { - "description": "Foreign Key to GeoData Column", - "example": "cl_8iw2o4ejzvdyna", - "type": "string" - }, - "fk_view_id": { - "description": "Unique ID for Map", - "example": "vw_qjt7klod1p9kyv", - "type": "string" - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "description": "Meta data for this view" - }, - "order": { - "description": "The order of the map list", - "type": "number" - }, - "project_id": { - "description": "The ID of the project that this view belongs to", - "example": "p_xm3thidrblw4n7", - "type": "string" - }, - "show": { - "description": "To show this Map or not", - "type": "boolean" - }, - "title": { - "description": "Title of Map View", - "example": "My Map", - "type": "string" - } - }, - "title": "Map Model", - "type": "object", - "x-stoplight": { - "id": "hd60sf3k0bs3w" - } - }, - "MapUpdateReq": { - "description": "Model for Map", - "x-stoplight": { - "id": "3hceyh9ukp5ln" - }, - "examples": [ - { - "fk_geo_data_col_id": "cl_8iw2o4ejzvdyna", - "meta": null - } - ], - "title": "Map View Update Request Model", - "type": "object", - "properties": { - "fk_geo_data_col_id": { - "description": "Foreign Key to GeoData Column", - "example": "cl_8iw2o4ejzvdyna", - "type": "string" - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "description": "Meta data for this view" - } - } - }, - "MapColumn": { - "description": "Model for Map Column", - "examples": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "fk_column_id": "cl_8iw2o4ejzvdyna", - "fk_view_id": "vw_qjt7klod1p9kyv", - "id": "nc_46xcacqn4rc9xf", - "order": 1, - "project_id": "p_xm3thidrblw4n7", - "show": 1 - } - ], - "properties": { - "base_id": { - "description": "The ID of the base that this map column belongs to", - "example": "ds_g4ccx6e77h1dmi", - "type": "string" - }, - "fk_column_id": { - "description": "Foreign Key to Column", - "example": "cl_8iw2o4ejzvdyna", - "type": "string" - }, - "fk_view_id": { - "description": "Foreign Key to View", - "example": "vw_qjt7klod1p9kyv", - "type": "string" - }, - "id": { - "description": "Unique ID of Map Column", - "example": "nc_46xcacqn4rc9xf", - "type": "string" - }, - "order": { - "description": "the order in the list of map columns", - "example": 1, - "type": "number" - }, - "project_id": { - "description": "The ID of the project that this map column belongs to", - "example": "p_xm3thidrblw4n7", - "type": "string" - }, - "show": { - "description": "Whether to show this column or not", - "example": 1, - "type": "number" - } - }, - "title": "Map Column Model", - "type": "object", - "x-stoplight": { - "id": "bvk0acuepoqw1" - } - }, - "Meta": { - "description": "Model for Meta", - "examples": [{}], - "oneOf": [ - { - "type": "null" - }, - { - "type": "object" - }, - { - "type": "string" - } - ], - "title": "Meta Model", - "x-stoplight": { - "id": "2ohjoms6hjcym" - } - }, - "ModelRoleVisibility": { - "description": "Model for ModelRoleVisibility", - "examples": [ - { - "base_id": "string", - "disabled": true, - "fk_model_id": "string", - "fk_view_id": "string", - "id": "string", - "project_id": "string", - "role": "string" - } - ], - "properties": { - "base_id": { - "type": "string" - }, - "disabled": { - "$ref": "#/components/schemas/Bool" - }, - "fk_model_id": { - "type": "string" - }, - "fk_view_id": { - "type": "string" - }, - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "project_id": { - "type": "string" - }, - "role": { - "type": "string" - } - }, - "title": "ModelRoleVisibility Model", - "type": "object", - "x-stoplight": { - "id": "68m1dblcswem2" - } - }, - "NormalColumnRequest": { - "description": "Model for Normal Column Request", - "examples": [ - { - "ai": true, - "au": true, - "cc": "string", - "cdf": "string", - "column_name": "string", - "csn": "string", - "dt": "string", - "dtx": "string", - "dtxp": 0, - "dtxs": 0, - "np": 0, - "ns": 0, - "pk": true, - "pv": true, - "rqd": true, - "title": "string", - "uidt": "ID", - "un": true, - "unique": true - } - ], - "properties": { - "ai": { - "$ref": "#/components/schemas/Bool", - "description": "Is this column auto-incremented?" - }, - "au": { - "$ref": "#/components/schemas/Bool", - "description": "Is this column auto-updated datetime field?" - }, - "cc": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Column Comment" - }, - "cdf": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Column Default Value" - }, - "column_name": { - "maxLength": 255, - "minLength": 1, - "type": "string", - "description": "Column Name" - }, - "csn": { - "$ref": "#/components/schemas/StringOrNull" - }, - "dt": { - "type": "string", - "description": "Data Type" - }, - "dtx": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Data Type Extra" - }, - "dtxp": { - "oneOf": [ - { - "$ref": "#/components/schemas/StringOrNull" - }, - { - "type": "number" - } - ], - "description": "Data Type Extra Precision" - }, - "dtxs": { - "oneOf": [ - { - "$ref": "#/components/schemas/StringOrNull" - }, - { - "type": "number" - } - ], - "description": "Data Type Extra Scale" - }, - "np": { - "oneOf": [ - { - "$ref": "#/components/schemas/StringOrNull" - }, - { - "type": "integer" - } - ], - "description": "Numeric Precision" - }, - "ns": { - "oneOf": [ - { - "$ref": "#/components/schemas/StringOrNull" - }, - { - "type": "integer" - } - ], - "description": "Numeric Scale" - }, - "pk": { - "$ref": "#/components/schemas/Bool", - "description": "Is this column a primary key?" - }, - "pv": { - "$ref": "#/components/schemas/Bool", - "description": "Is this column a primary value?" - }, - "rqd": { - "$ref": "#/components/schemas/Bool", - "description": "Is this column required?" - }, - "title": { - "maxLength": 255, - "type": "string", - "description": "Column Title" - }, - "uidt": { - "enum": [ - "Attachment", - "AutoNumber", - "Barcode", - "Button", - "Checkbox", - "Collaborator", - "Count", - "CreateTime", - "Currency", - "Date", - "DateTime", - "Decimal", - "Duration", - "Email", - "Formula", - "ForeignKey", - "GeoData", - "Geometry", - "ID", - "JSON", - "LastModifiedTime", - "LongText", - "LinkToAnotherRecord", - "Lookup", - "MultiSelect", - "Number", - "Percent", - "PhoneNumber", - "Rating", - "Rollup", - "SingleLineText", - "SingleSelect", - "SpecificDBType", - "Time", - "URL", - "Year", - "QrCode" - ], - "type": "string", - "description": "UI Data Type" - }, - "un": { - "$ref": "#/components/schemas/Bool", - "description": "Is this column unique?" - }, - "unique": { - "$ref": "#/components/schemas/Bool", - "description": "Is this column unique?" - } - }, - "title": "Normal Column Request Model", - "type": "object", - "required": ["column_name"], - "x-stoplight": { - "id": "b67hswwa49t9u" - } - }, - "OrgUserReq": { - "description": "Model for Organisation User Update Request", - "examples": [ - { - "email": "user@example.com", - "roles": "org-level-creator" - } - ], - "properties": { - "email": { - "format": "email", - "type": "string" - }, - "roles": { - "enum": ["org-level-creator", "org-level-viewer"], - "type": "string", - "description": "Roles for the project user" - } - }, - "title": "Organisation User Request Model", - "type": "object", - "x-stoplight": { - "id": "hs5aforkqjbkb" - } - }, - "Paginated": { - "description": "Model for Paginated", - "examples": [ - { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - ], - "properties": { - "isFirstPage": { - "description": "Is the current page the first page", - "type": "boolean" - }, - "isLastPage": { - "description": "Is the current page the last page", - "type": "boolean" - }, - "page": { - "description": "The current page", - "example": 1, - "type": "number" - }, - "pageSize": { - "description": "The number of pages", - "example": 10, - "type": "number" - }, - "totalRows": { - "description": "The number of rows in the given result", - "example": 1, - "type": "number" - } - }, - "title": "Paginated Model", - "type": "object", - "x-stoplight": { - "id": "ny0v2losvmitz" - } - }, - "Password": { - "description": "Model for Password", - "example": "password123456789", - "examples": ["password123456789"], - "minLength": 8, - "title": "Password Model", - "type": "string", - "x-stoplight": { - "id": "c6iocwuo2j8z8" - } - }, - "PasswordChangeReq": { - "description": "Model for Password Change Request", - "examples": [ - { - "currentPassword": "currentpassword", - "newPassword": "newpassword" - } - ], - "properties": { - "currentPassword": { - "type": "string" - }, - "newPassword": { - "minLength": 8, - "type": "string" - } - }, - "required": ["currentPassword", "newPassword"], - "title": "Password Change Request Model", - "type": "object", - "x-stoplight": { - "id": "99dogahvh0gla" - } - }, - "PasswordForgotReq": { - "description": "Model for Password Forgot Request", - "examples": [ - { - "email": "user@example.com" - } - ], - "properties": { - "email": { - "description": "Email address of the user", - "format": "email", - "type": "string" - } - }, - "required": ["email"], - "title": "Password Forgot Request Model", - "type": "object", - "x-stoplight": { - "id": "1kkft7m54ax45" - } - }, - "PasswordResetReq": { - "description": "Model for Password Reset Request", - "examples": [ - { - "password": "newpassword" - } - ], - "properties": { - "password": { - "description": "New password", - "example": "newpassword", - "minLength": 8, - "type": "string" - } - }, - "required": ["password"], - "title": "Password Reset Request Model", - "type": "object", - "x-stoplight": { - "id": "i3gzz403zjwh8" - } - }, - "Plugin": { - "description": "Model for Plugin", - "examples": [ - { - "id": "nc_tljibbzcyjrhcc", - "title": "S3", - "description": "Amazon Simple Storage Service (Amazon S3) is an object storage service that offers industry-leading scalability, data availability, security, and performance.", - "active": true, - "rating": null, - "version": "0.0.1", - "docs": null, - "status": "install", - "status_details": null, - "logo": "plugins/s3.png", - "icon": null, - "tags": "Storage", - "category": "Storage", - "input_schema": "{\"title\":\"Configure Amazon S3\",\"items\":[{\"key\":\"bucket\",\"label\":\"Bucket Name\",\"placeholder\":\"Bucket Name\",\"type\":\"SingleLineText\",\"required\":true},{\"key\":\"region\",\"label\":\"Region\",\"placeholder\":\"Region\",\"type\":\"SingleLineText\",\"required\":true},{\"key\":\"access_key\",\"label\":\"Access Key\",\"placeholder\":\"Access Key\",\"type\":\"SingleLineText\",\"required\":true},{\"key\":\"access_secret\",\"label\":\"Access Secret\",\"placeholder\":\"Access Secret\",\"type\":\"Password\",\"required\":true}],\"actions\":[{\"label\":\"Test\",\"placeholder\":\"Test\",\"key\":\"test\",\"actionType\":\"TEST\",\"type\":\"Button\"},{\"label\":\"Save\",\"placeholder\":\"Save\",\"key\":\"save\",\"actionType\":\"SUBMIT\",\"type\":\"Button\"}],\"msgOnInstall\":\"Successfully installed and attachment will be stored in AWS S3\",\"msgOnUninstall\":\"\"}", - "input": "{\"bucket\":\"my-bucket\",\"region\":\"us-west-004\",\"access_key\":\"redacted\",\"access_secret\":\"redacted\"}", - "creator": null, - "creator_website": null, - "price": null - } - ], - "title": "Plugin Model", - "type": "object", - "properties": { - "active": { - "$ref": "#/components/schemas/Bool", - "description": "Is plguin active?" - }, - "category": { - "type": "string", - "description": "Plugin Category", - "example": "Storage" - }, - "creator": { - "type": "string", - "description": "Plugin Creator (Not in use)" - }, - "creator_website": { - "type": "string", - "description": "Plugin Creator website (Not in use)" - }, - "description": { - "type": "string", - "description": "Plugin Description", - "example": "Amazon Simple Storage Service (Amazon S3) is an object storage service that offers industry-leading scalability, data availability, security, and performance." - }, - "docs": { - "type": "string", - "description": "Documentation of plugin (Not in use)" - }, - "icon": { - "type": "string", - "description": "Plugin Icon (Not in use)" - }, - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "input": { - "oneOf": [ - { - "$ref": "#/components/schemas/StringOrNull" - }, - { - "type": "integer" - } - ], - "description": "Plugin Input" - }, - "input_schema": { - "type": "string", - "description": "Plugin Input Schema\n" - }, - "logo": { - "type": "string", - "description": "Plugin logo", - "example": "plugins/s3.png" - }, - "price": { - "type": "string", - "description": "Plugin Price (Not in use)" - }, - "rating": { - "type": "number", - "description": "Plugin Rating (Not in use)" - }, - "status": { - "type": "string", - "description": "Plugin Status", - "example": "install" - }, - "status_details": { - "type": "string", - "description": "Not in use" - }, - "tags": { - "type": "string", - "description": "Plugin tags", - "example": "Storage" - }, - "title": { - "type": "string", - "description": "Plugin Title" - }, - "version": { - "type": "string", - "description": "Plugin Version", - "example": "0.0.1" - } - }, - "x-stoplight": { - "id": "uux5n95kbh2r5" - } - }, - "PluginReq": { - "description": "Model for Plugin Request", - "examples": [ - { - "active": 0, - "input": "{\"bucket\":\"my-bucket\",\"region\":\"us-west-004\",\"access_key\":\"redacted\",\"access_secret\":\"redacted\"}" - } - ], - "title": "Plugin Reqeust", - "type": "object", - "properties": { - "active": { - "$ref": "#/components/schemas/Bool", - "description": "Is Plugin Active?" - }, - "input": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Plugin Input" - } - }, - "x-stoplight": { - "id": "pci8zg4wgn3bx" - } - }, - "PluginTestReq": { - "description": "Model for Plugin Test Request", - "examples": [ - { - "title": "Plugin Foo", - "input": "{\"bucket\":\"my-bucket\",\"region\":\"us-west-004\",\"access_key\":\"redacted\",\"access_secret\":\"redacted\"}", - "category": "Email" - } - ], - "title": "Plugin Test Request Model", - "type": "object", - "properties": { - "title": { - "maxLength": 45, - "type": "string", - "description": "Plugin Title" - }, - "input": { - "oneOf": [ - { - "type": "string", - "description": "Plugin Input as JSON string" - }, - { - "description": "Plugin Input", - "type": "object" - } - ] - }, - "category": { - "x-stoplight": { - "id": "rg3i3ov9rs6d0" - }, - "type": "string", - "example": "Email" - } - }, - "required": ["title", "input", "category"], - "x-stoplight": { - "id": "gest5kbecpjdi" - } - }, - "Project": { - "description": "Model for Project", - "examples": [ - { - "bases": [ - { - "alias": "string", - "config": null, - "enabled": true, - "id": "string", - "inflection_column": "camelize", - "inflection_table": "camelize", - "is_meta": true, - "order": 1, - "project_id": "string", - "type": "mysql2", - "updated_at": "2023-03-01 14:27:36" - } - ], - "color": "#24716E", - "created_at": "2023-03-01 14:27:36", - "deleted": true, - "description": "This is my project description", - "id": "p_124hhlkbeasewh", - "is_meta": true, - "meta": {}, - "order": 0, - "prefix": "nc_vm5q__", - "status": "string", - "title": "my-project" - } - ], - "title": "Project Model", - "type": "object", - "properties": { - "bases": { - "description": "List of base models", - "type": "array", - "items": { - "$ref": "#/components/schemas/Base" - } - }, - "color": { - "description": "Primary Theme Color", - "example": "#24716E", - "type": "string" - }, - "deleted": { - "$ref": "#/components/schemas/Bool", - "description": "Is the project deleted" - }, - "description": { - "description": "Project Description", - "example": "This is my project description", - "type": "string" - }, - "id": { - "description": "Unique Project ID", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "is_meta": { - "$ref": "#/components/schemas/Bool" - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "description": "Meta Info such as theme colors" - }, - "order": { - "description": "The order in project list", - "type": "number" - }, - "prefix": { - "description": "Project prefix. Used in XCDB only.", - "example": "nc_vm5q__", - "type": "string" - }, - "status": { - "type": "string" - }, - "title": { - "description": "Project Title", - "example": "my-project", - "type": "string" - } - }, - "x-stoplight": { - "id": "gae6rj3whdnj9" - } - }, - "ProjectList": { - "description": "Model for Project List", - "examples": [ - { - "list": [ - { - "bases": [ - { - "alias": "string", - "config": null, - "created_at": "2023-03-01 14:27:36", - "enabled": true, - "id": "string", - "inflection_column": "camelize", - "inflection_table": "camelize", - "is_meta": true, - "order": 1, - "project_id": "string", - "type": "mysql2", - "updated_at": "2023-03-01 14:27:36" - } - ], - "color": "#24716E", - "created_at": "2023-03-01 14:27:36", - "deleted": true, - "description": "This is my project description", - "id": "p_124hhlkbeasewh", - "is_meta": true, - "meta": {}, - "order": 0, - "prefix": "nc_vm5q__", - "status": "string", - "title": "my-project", - "updated_at": "2023-03-01 14:27:36" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - ], - "title": "Project List Model", - "type": "object", - "x-examples": { - "example-1": { - "bases": { - "list": [ - { - "alias": "string", - "database": "string", - "host": "string", - "id": "string", - "params": "string", - "password": "string", - "port": 0, - "project_id": "string", - "ssl": "string", - "type": "string", - "url": "string", - "username": "string" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "pageSize": 0, - "sort": "string", - "totalRows": 0 - } - } - } - }, - "properties": { - "list": { - "description": "List of Project Models", - "minItems": 1, - "type": "array", - "uniqueItems": true, - "items": { - "$ref": "#/components/schemas/Project" - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated", - "description": "Pagination Info" - } - }, - "required": ["list", "pageInfo"], - "x-stoplight": { - "id": "xbosckfm1h9l0" - } - }, - "ProjectReq": { - "description": "Model for Project Request", - "examples": [ - { - "bases": [ - { - "alias": "My Base", - "config": null, - "inflection_column": "camelize", - "inflection_table": "camelize", - "is_meta": true, - "type": "mysql" - } - ], - "color": "#24716E", - "description": "This is my project description", - "title": "My Project" - } - ], - "properties": { - "bases": { - "description": "Array of Bases", - "items": { - "$ref": "#/components/schemas/BaseReq" - }, - "type": "array" - }, - "color": { - "description": "Primary Theme Color", - "example": "#24716E", - "maxLength": 50, - "type": "string" - }, - "description": { - "description": "Project Description", - "example": "This is my project description", - "type": "string" - }, - "title": { - "description": "Project Title", - "example": "My Project", - "maxLength": 128, - "minLength": 1, - "type": "string" - } - }, - "required": ["title"], - "title": "Project Request Model", - "type": "object", - "x-stoplight": { - "id": "aicbp4keo57ld" - } - }, - "ProjectUpdateReq": { - "description": "Model for Project Update Request", - "x-stoplight": { - "id": "83257b35r118q" - }, - "examples": [ - { - "color": "#24716E", - "meta": null, - "title": "My Project" - } - ], - "title": "Project Update Request Model", - "type": "object", - "properties": { - "color": { - "description": "Primary Theme Color", - "example": "#24716E", - "maxLength": 50, - "type": "string" - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "description": "Project Meta", - "x-stoplight": { - "id": "m05w9sbwqgul3" - } - }, - "title": { - "description": "Project Title", - "example": "My Project", - "maxLength": 128, - "minLength": 1, - "type": "string" - } - } - }, - "ProjectUserReq": { - "description": "Model for Project User Request", - "examples": [ - { - "email": "user@example.com", - "roles": "owner" - } - ], - "title": "Project User Request Model", - "type": "object", - "properties": { - "email": { - "format": "email", - "type": "string", - "description": "Project User Email" - }, - "roles": { - "enum": [ - "commenter", - "editor", - "guest", - "owner", - "viewer", - "creator" - ], - "type": "string", - "description": "Project User Role" - } - }, - "required": ["email", "roles"], - "x-stoplight": { - "id": "tq2wpd2agebjz" - } - }, - "Rollup": { - "description": "Model for Rollup", - "examples": [ - { - "id": "rl_kc19pbdkij8wly", - "fk_column_id": "cl_588b63mneri2yi", - "fk_relation_column_id": "cl_c09q6eu6hsvn4s", - "fk_rollup_column_id": "cl_m62i1vyl23n8co", - "rollup_function": "count" - } - ], - "title": "Rollup Model", - "type": "object", - "properties": { - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "fk_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Column" - }, - "fk_relation_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign to Relation Column" - }, - "fk_rollup_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign to Rollup Column" - }, - "rollup_function": { - "type": "string", - "description": "Rollup Function", - "example": "count", - "enum": [ - "count", - "min", - "max", - "avg", - "countDistinct", - "sumDistinct", - "avgDistinct" - ] - } - }, - "x-stoplight": { - "id": "vdzh0qojyn9a9" - } - }, - "RollupColumnReq": { - "description": "Model for Rollup Column Request", - "examples": [ - { - "fk_relation_column_id": "cl_c09q6eu6hsvn4s", - "fk_rollup_column_id": "cl_m62i1vyl23n8co", - "title": "Rollup Column", - "rollup_function": "avg", - "uidt": "Rollup" - } - ], - "title": "Rollup Column Request Model", - "type": "object", - "properties": { - "fk_relation_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Relation Column" - }, - "fk_rollup_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Rollup Column" - }, - "title": { - "maxLength": 255, - "type": "string", - "description": "Rollup Column Title" - }, - "rollup_function": { - "enum": [ - "avg", - "avgDistinct", - "count", - "countDistinct", - "max", - "min", - "sum", - "sumDistinct" - ], - "type": "string", - "description": "Rollup Function" - }, - "uidt": { - "enum": ["Rollup"], - "type": "string", - "description": "UI DataType" - } - }, - "x-stoplight": { - "id": "uw9fq6lp1lone" - } - }, - "SelectOption": { - "description": "Model for SelectOption", - "examples": [ - { - "id": "sl_hvfeuagqtlzzbk", - "title": "Option A", - "fk_column_id": "cl_35zmvi2tezfipw", - "color": "#cfdffe", - "order": 1 - } - ], - "title": "SelectOption Model", - "type": "object", - "properties": { - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "title": { - "type": "string", - "description": "Option Title\n", - "example": "Option A" - }, - "fk_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Column" - }, - "color": { - "type": "string", - "description": "Option Color", - "example": "#cfdffe" - }, - "order": { - "type": "number", - "description": "The order among the options", - "example": 1 - } - }, - "x-stoplight": { - "id": "onnh5qie1ul32" - } - }, - "SelectOptions": { - "description": "Model for SelectOptions", - "examples": [ - { - "options": [ - { - "id": "sl_hvfeuagqtlzzbk", - "title": "Option A", - "fk_column_id": "cl_35zmvi2tezfipw", - "color": "#cfdffe", - "order": 1 - } - ] - } - ], - "title": "SelectOptions Model", - "type": "object", - "properties": { - "options": { - "type": "array", - "description": "Array of select options", - "items": { - "$ref": "#/components/schemas/SelectOption" - } - } - }, - "required": ["options"], - "x-stoplight": { - "id": "3i68n0spduuf9" - } - }, - "SharedBaseReq": { - "description": "Model for Shared Base Request", - "examples": [ - { - "password": "password123", - "roles": "editor" - } - ], - "title": "Shared Base Request Model", - "type": "object", - "properties": { - "password": { - "minLength": 8, - "type": "string", - "description": "Password to protect the base", - "example": "password123" - }, - "roles": { - "enum": ["commenter", "editor", "viewer"], - "type": "string", - "description": "The role given the target user", - "example": "editor" - } - }, - "x-stoplight": { - "id": "ep7ikmx3sudcl" - } - }, - "SharedView": { - "$ref": "#/components/schemas/View", - "description": "Model for Shared View", - "title": "SharedView", - "examples": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:46:31", - "fk_model_id": "md_mhs9z4r2ak98x0", - "id": "vw_lg052cnc1c26kf", - "is_default": 1, - "lock_type": "collaborative", - "meta": {}, - "order": 1, - "password": null, - "project_id": "p_xm3thidrblw4n7", - "show": 1, - "show_system_fields": null, - "title": "Sheet-1", - "type": 3, - "updated_at": "2023-03-02 17:46:31", - "uuid": null, - "view": { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:46:31", - "fk_view_id": "vw_lg052cnc1c26kf", - "meta": null, - "project_id": "p_xm3thidrblw4n7", - "row_height": null, - "updated_at": "2023-03-02 17:46:31", - "uuid": null - } - } - ], - "x-stoplight": { - "id": "fqfohevz2zj4u" - } - }, - "SharedViewList": { - "description": "Model for Shared View List", - "examples": [ - { - "list": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:46:31", - "fk_model_id": "md_mhs9z4r2ak98x0", - "id": "vw_lg052cnc1c26kf", - "is_default": 1, - "lock_type": "collaborative", - "meta": {}, - "order": 1, - "password": null, - "project_id": "p_xm3thidrblw4n7", - "show": 1, - "show_system_fields": null, - "title": "Sheet-1", - "type": 3, - "updated_at": "2023-03-02 17:46:31", - "uuid": null, - "view": { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:46:31", - "fk_view_id": "vw_lg052cnc1c26kf", - "meta": null, - "project_id": "p_xm3thidrblw4n7", - "row_height": null, - "updated_at": "2023-03-02 17:46:31", - "uuid": null - } - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - ], - "title": "Shared View List Model", - "type": "object", - "x-examples": { - "example-1": { - "bases": { - "list": [ - { - "alias": "string", - "database": "string", - "host": "string", - "id": "string", - "params": "string", - "password": "string", - "port": 0, - "project_id": "string", - "ssl": "string", - "type": "string", - "url": "string", - "username": "string" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "pageSize": 0, - "sort": "string", - "totalRows": 0 - } - } - } - }, - "properties": { - "list": { - "minItems": 1, - "type": "array", - "uniqueItems": true, - "description": "List of shared view objects", - "items": { - "$ref": "#/components/schemas/SharedView" - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated", - "description": "Paginated Info" - } - }, - "required": ["list", "pageInfo"], - "x-stoplight": { - "id": "zdpekhmw0wvj3" - } - }, - "SharedViewReq": { - "description": "Model for Shared View Request", - "examples": [ - { - "meta": {}, - "password": "123456789" - } - ], - "title": "Shared View Request Model", - "type": "object", - "properties": { - "meta": { - "$ref": "#/components/schemas/Meta", - "description": "Meta data passing to Shared View such as if download is allowed or not." - }, - "password": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Password to restrict access" - } - }, - "x-stoplight": { - "id": "0g3o2uo9y4h4g" - } - }, - "SignInReq": { - "description": "Model for Signin Request", - "examples": [ - { - "email": "user@example.com", - "password": "string" - } - ], - "properties": { - "email": { - "description": "Email address of the user", - "format": "email", - "type": "string" - }, - "password": { - "description": "Password of the user", - "type": "string" - } - }, - "required": ["email", "password"], - "title": "Signin Request Model", - "type": "object", - "x-stoplight": { - "id": "dxxafjky40cz1" - } - }, - "SignUpReq": { - "description": "Model for Signup Request", - "examples": [ - { - "email": "user@example.com", - "password": "password123456789", - "firstname": "Alice", - "lastname": "Smith", - "token": null, - "ignore_subscribe": 0 - } - ], - "title": "Signup Request Model", - "type": "object", - "properties": { - "email": { - "description": "Email address of the user", - "example": "user@example.com", - "format": "email", - "type": "string" - }, - "password": { - "description": "Password of the user", - "example": "password123456789", - "minLength": 8, - "type": "string" - }, - "firstname": { - "$ref": "#/components/schemas/StringOrNull", - "x-stoplight": { - "id": "lblivgs8wcsm1" - } - }, - "lastname": { - "$ref": "#/components/schemas/StringOrNull", - "x-stoplight": { - "id": "d4341r35tucq3" - } - }, - "token": { - "$ref": "#/components/schemas/StringOrNull", - "x-stoplight": { - "id": "otw9jgnr9n7c4" - }, - "description": "Sign Up Token. Used for invitation." - }, - "ignore_subscribe": { - "$ref": "#/components/schemas/Bool", - "x-stoplight": { - "id": "g7ge6mc6vdsds" - }, - "description": "Ignore Subscription" - } - }, - "required": ["email", "password"], - "x-stoplight": { - "id": "2rcbk0flkc4yu" - } - }, - "Sort": { - "description": "Model for Sort", - "examples": [ - { - "id": "so_xd4t51uv60ghzl", - "fk_column_id": "cl_l11b769pe2j1ce", - "fk_model_id": "md_ehn5izr99m7d45", - "base_id": "ds_3l9qx8xqksenrl", - "direction": "desc", - "order": 1, - "project_id": "p_9sx43moxhqtjm3" - } - ], - "title": "Sort Model", - "type": "object", - "properties": { - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "fk_column_id": { - "$ref": "#/components/schemas/Id" - }, - "fk_model_id": { - "$ref": "#/components/schemas/Id" - }, - "base_id": { - "type": "string", - "description": "Base ID", - "example": "ds_3l9qx8xqksenrl", - "readOnly": true - }, - "direction": { - "type": "string", - "description": "Sort direction", - "enum": ["asc", "desc"], - "example": "desc" - }, - "order": { - "type": "number", - "example": 1 - }, - "project_id": { - "type": "string", - "description": "Project ID", - "example": "p_9sx43moxhqtjm3", - "readOnly": true - } - }, - "x-stoplight": { - "id": "3jjbe2mjzy5li" - } - }, - "SortList": { - "description": "Model for Sort List", - "examples": [ - { - "list": [ - { - "id": "so_xd4t51uv60ghzl", - "fk_column_id": "cl_l11b769pe2j1ce", - "fk_model_id": "md_ehn5izr99m7d45", - "base_id": "ds_3l9qx8xqksenrl", - "direction": "desc", - "order": 1, - "project_id": "p_9sx43moxhqtjm3" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - ], - "title": "Sort List Model", - "type": "object", - "x-examples": { - "example-1": { - "bases": { - "list": [ - { - "alias": "string", - "database": "string", - "host": "string", - "id": "string", - "params": "string", - "password": "string", - "port": 0, - "project_id": "string", - "ssl": "string", - "type": "string", - "url": "string", - "username": "string" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "pageSize": 0, - "sort": "string", - "totalRows": 0 - } - } - } - }, - "properties": { - "list": { - "type": "array", - "x-stoplight": { - "id": "gjqqc8ciqg947" - }, - "description": "List of Sort Objects", - "items": { - "$ref": "#/components/schemas/Sort", - "x-stoplight": { - "id": "usnfa1kbovpmb" - } - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated", - "x-stoplight": { - "id": "i75wcejfp5mnq" - } - } - }, - "required": ["list", "pageInfo"], - "x-stoplight": { - "id": "fsq6d3pi8b3iz" - } - }, - "SortReq": { - "description": "Model for Sort Request", - "examples": [ - { - "direction": "asc", - "fk_column_id": "cl_l11b769pe2j1ce" - } - ], - "minProperties": 1, - "title": "Sort Request Model", - "type": "object", - "properties": { - "fk_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Column" - }, - "direction": { - "description": "Sort direction", - "enum": ["asc", "desc"], - "type": "string" - } - }, - "x-stoplight": { - "id": "lao7jfow2dbe7" - } - }, - "StringOrNull": { - "description": "Model for StringOrNull", - "examples": ["string"], - "oneOf": [ - { - "maxLength": 255, - "type": "string" - }, - { - "type": "null" - } - ], - "title": "StringOrNull Model", - "x-stoplight": { - "id": "xh9dwrizrvfh6" - } - }, - "Table": { - "description": "Model for Table", - "examples": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "columns": [ - { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": "CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP", - "clen": null, - "column_name": "updated_at", - "cop": "4", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "timestamp", - "deleted": null, - "dt": "timestamp", - "dtx": "specificType", - "dtxp": "0", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_m4wkaqgqqjzoeh", - "meta": null, - "np": null, - "ns": null, - "order": 4, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 0, - "system": 0, - "title": "UpdatedAt", - "uidt": "DateTime", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": "CURRENT_TIMESTAMP", - "clen": null, - "column_name": "created_at", - "cop": "3", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "timestamp", - "deleted": null, - "dt": "timestamp", - "dtx": "specificType", - "dtxp": "0", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_jpl0qu4gj4rexq", - "meta": null, - "np": null, - "ns": null, - "order": 3, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 0, - "system": 0, - "title": "CreatedAt", - "uidt": "DateTime", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": null, - "clen": "45", - "column_name": "title", - "cop": "2", - "created_at": "2023-03-02 17:04:06", - "csn": "utf8mb4", - "ct": "varchar(45)", - "deleted": null, - "dt": "varchar", - "dtx": "specificType", - "dtxp": "45", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_c5knoi4xs4sfpt", - "meta": null, - "np": null, - "ns": null, - "order": 2, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": 1, - "rqd": 0, - "system": 0, - "title": "Title", - "uidt": "SingleLineText", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - { - "ai": 1, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": null, - "clen": null, - "column_name": "id", - "cop": "1", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "int unsigned", - "deleted": null, - "dt": "int", - "dtx": "specificType", - "dtxp": "", - "dtxs": "0", - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_phvuuwjrzcdo0g", - "meta": null, - "np": "10", - "ns": "0", - "order": 1, - "pk": 1, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 1, - "system": 0, - "title": "Id", - "uidt": "ID", - "un": 1, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - } - ], - "columnsById": { - "cl_c5knoi4xs4sfpt": { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": null, - "clen": "45", - "column_name": "title", - "cop": "2", - "created_at": "2023-03-02 17:04:06", - "csn": "utf8mb4", - "ct": "varchar(45)", - "deleted": null, - "dt": "varchar", - "dtx": "specificType", - "dtxp": "45", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_c5knoi4xs4sfpt", - "meta": null, - "np": null, - "ns": null, - "order": 2, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": 1, - "rqd": 0, - "system": 0, - "title": "Title", - "uidt": "SingleLineText", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - "cl_jpl0qu4gj4rexq": { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": "CURRENT_TIMESTAMP", - "clen": null, - "column_name": "created_at", - "cop": "3", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "timestamp", - "deleted": null, - "dt": "timestamp", - "dtx": "specificType", - "dtxp": "0", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_jpl0qu4gj4rexq", - "meta": null, - "np": null, - "ns": null, - "order": 3, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 0, - "system": 0, - "title": "CreatedAt", - "uidt": "DateTime", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - "cl_m4wkaqgqqjzoeh": { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": "CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP", - "clen": null, - "column_name": "updated_at", - "cop": "4", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "timestamp", - "deleted": null, - "dt": "timestamp", - "dtx": "specificType", - "dtxp": "0", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_m4wkaqgqqjzoeh", - "meta": null, - "np": null, - "ns": null, - "order": 4, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 0, - "system": 0, - "title": "UpdatedAt", - "uidt": "DateTime", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - "cl_phvuuwjrzcdo0g": { - "ai": 1, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": null, - "clen": null, - "column_name": "id", - "cop": "1", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "int unsigned", - "deleted": null, - "dt": "int", - "dtx": "specificType", - "dtxp": "", - "dtxs": "0", - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_phvuuwjrzcdo0g", - "meta": null, - "np": "10", - "ns": "0", - "order": 1, - "pk": 1, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 1, - "system": 0, - "title": "Id", - "uidt": "ID", - "un": 1, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - } - }, - "created_at": "2023-03-02 17:04:06", - "deleted": null, - "enabled": 1, - "id": "md_rsu68aqjsbyqtl", - "meta": null, - "mm": 0, - "order": 1, - "pinned": null, - "project_id": "p_xm3thidrblw4n7", - "schema": null, - "table_name": "nc_vm5q___Table1", - "tags": null, - "title": "Table1", - "type": "table", - "updated_at": "2023-03-02 17:04:08", - "views": [ - { - "_ptn": "Table1", - "_tn": "Table1", - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:04:06", - "disabled": { - "commenter": false, - "creator": false, - "editor": false, - "guest": false, - "owner": false, - "viewer": false - }, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "vw_p2jcatxz4mvcfw", - "is_default": 1, - "lock_type": "collaborative", - "meta": {}, - "order": 1, - "password": null, - "project_id": "p_xm3thidrblw4n7", - "ptn": "nc_vm5q___Table1", - "ptype": "table", - "show": 1, - "show_system_fields": null, - "table_meta": null, - "title": "Table1", - "tn": "Table1", - "type": 3, - "updated_at": "2023-03-02 17:04:06", - "uuid": null, - "view": { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:04:06", - "fk_view_id": "vw_p2jcatxz4mvcfw", - "meta": null, - "project_id": "p_xm3thidrblw4n7", - "row_height": null, - "updated_at": "2023-03-02 17:04:06", - "uuid": null - } - } - ] - } - ], - "title": "Table Model", - "type": "object", - "properties": { - "base_id": { - "description": "Unique Base ID", - "type": "string" - }, - "columns": { - "description": "The columns included in this table", - "type": "array", - "items": { - "$ref": "#/components/schemas/Column" - } - }, - "columnsById": { - "description": "Column Models grouped by IDs", - "type": "object" - }, - "deleted": { - "$ref": "#/components/schemas/Bool" - }, - "enabled": { - "$ref": "#/components/schemas/Bool", - "description": "Is this table enabled?" - }, - "id": { - "description": "Unique Table ID", - "type": "string" - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "description": "Meta Data" - }, - "mm": { - "$ref": "#/components/schemas/Bool", - "description": "Is this table used for M2M" - }, - "order": { - "description": "The order of the list of tables", - "type": "number" - }, - "pinned": { - "$ref": "#/components/schemas/Bool", - "description": "Currently not in use" - }, - "project_id": { - "description": "Unique Project ID", - "type": "string" - }, - "table_name": { - "description": "Table Name. Prefix will be added for XCDB projects.", - "type": "string" - }, - "tags": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Currently not in use" - }, - "title": { - "description": "Table Title", - "type": "string" - }, - "type": { - "description": "Table Type", - "type": "string" - } - }, - "required": ["table_name", "title"], - "x-stoplight": { - "id": "rvdu5okgpz1xk" - } - }, - "TableList": { - "description": "Model for Table List", - "examples": [ - { - "list": [ - { - "alias": "string", - "base_id": "string", - "column": [ - { - "alias": "string", - "auto_increment": true, - "auto_update_timestamp": true, - "base_id": "string", - "character_maximum_length": "string", - "character_set_name": "string", - "colOptions": { - "deleted": "string", - "dr": "string", - "fk_child_column_id": "string", - "fk_column_id": "string", - "fk_index_name": "string", - "fk_mm_child_column_id": "string", - "fk_mm_model_id": "string", - "fk_mm_parent_column_id": "string", - "fk_parent_column_id": "string", - "id": "string", - "order": "string", - "type": "string", - "ur": "string", - "virtual": true - }, - "column_comment": "string", - "column_default": "string", - "column_ordinal_position": "string", - "column_type": "string", - "data_type": "string", - "data_type_x": "string", - "data_type_x_precision": "string", - "data_type_x_scale": "string", - "deleted": true, - "fk_model_id": "string", - "id": "string", - "numeric_precision": "string", - "numeric_scale": "string", - "order": 0, - "primary_key": true, - "primary_value": true, - "rqd": "string", - "title": "string", - "ui_data_type": "string", - "un": "string", - "unique": true, - "visible": true - } - ], - "columnByIds": {}, - "deleted": true, - "enabled": true, - "id": "string", - "order": 0, - "parent_id": "string", - "pinned": true, - "project_id": "string", - "show_as": "string", - "tags": "string", - "title": "string", - "type": "string" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - ], - "title": "Table List Model", - "type": "object", - "x-examples": { - "example-1": { - "bases": { - "list": [ - { - "alias": "string", - "database": "string", - "host": "string", - "id": "string", - "params": "string", - "password": "string", - "port": 0, - "project_id": "string", - "ssl": "string", - "type": "string", - "url": "string", - "username": "string" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "pageSize": 0, - "sort": "string", - "totalRows": 0 - } - } - } - }, - "properties": { - "list": { - "minItems": 1, - "type": "array", - "uniqueItems": true, - "description": "List of table objects", - "items": { - "$ref": "#/components/schemas/Table" - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated", - "description": "Paginated Info" - } - }, - "required": ["list", "pageInfo"], - "x-stoplight": { - "id": "25z7dodhqs3lc" - } - }, - "TableReq": { - "description": "Model for Table Request", - "examples": [ - { - "columns": [ - { - "ai": false, - "altered": 1, - "cdf": "CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP", - "ck": false, - "clen": 45, - "column_name": "updated_at", - "ct": "varchar(45)", - "dt": "timestamp", - "dtx": "specificType", - "dtxp": "", - "dtxs": "", - "np": null, - "nrqd": true, - "ns": null, - "pk": false, - "rqd": false, - "title": "UpdatedAt", - "uicn": "", - "uidt": "DateTime", - "uip": "", - "un": false - }, - { - "ai": false, - "altered": 1, - "cdf": "CURRENT_TIMESTAMP", - "ck": false, - "clen": 45, - "column_name": "created_at", - "ct": "varchar(45)", - "dt": "timestamp", - "dtx": "specificType", - "dtxp": "", - "dtxs": "", - "np": null, - "nrqd": true, - "ns": null, - "pk": false, - "rqd": false, - "title": "CreatedAt", - "uicn": "", - "uidt": "DateTime", - "uip": "", - "un": false - }, - { - "ai": false, - "altered": 1, - "cdf": null, - "ck": false, - "clen": 45, - "column_name": "title", - "ct": "varchar(45)", - "dt": "varchar", - "dtx": "specificType", - "dtxp": "45", - "dtxs": "", - "np": null, - "nrqd": true, - "ns": null, - "pk": false, - "rqd": false, - "title": "Title", - "uicn": "", - "uidt": "SingleLineText", - "uip": "", - "un": false - }, - { - "ai": true, - "altered": 1, - "cdf": null, - "ck": false, - "clen": null, - "column_name": "id", - "ct": "int(11)", - "dt": "int", - "dtx": "integer", - "dtxp": "11", - "dtxs": "", - "np": 11, - "nrqd": false, - "ns": 0, - "pk": true, - "rqd": true, - "title": "Id", - "uicn": "", - "uidt": "ID", - "uip": "", - "un": true - } - ], - "table_name": "Sheet-1", - "title": "Sheet-1" - } - ], - "properties": { - "columns": { - "description": "The column models in this table", - "items": { - "$ref": "#/components/schemas/NormalColumnRequest" - }, - "type": "array" - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "description": "the meta data for this table" - }, - "order": { - "description": "The order of table list", - "example": 1, - "type": "number" - }, - "table_name": { - "description": "Table name", - "example": "my_table", - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "title": { - "description": "Table title", - "example": "My Table", - "maxLength": 255, - "minLength": 0, - "type": "string" - } - }, - "required": ["columns", "table_name"], - "title": "Table Request Model", - "type": "object", - "x-stoplight": { - "id": "kilqakhuuzstv" - } - }, - "User": { - "description": "Model for User", - "examples": [ - { - "email": "user@example.com", - "email_verified": true, - "firstname": "Alice", - "id": "us_8kugj628ebjngs", - "lastname": "Smith", - "roles": "org-level-viewer" - } - ], - "title": "User Model", - "type": "object", - "x-internal": false, - "properties": { - "email": { - "description": "The email of the user", - "example": "user@example.com", - "format": "email", - "type": "string" - }, - "email_verified": { - "description": "Set to true if the user's email has been verified.", - "type": "boolean" - }, - "firstname": { - "description": "The first name of the user", - "example": "Alice", - "type": "string" - }, - "id": { - "description": "Unique identifier for the given user.", - "example": "us_8kugj628ebjngs", - "type": "string" - }, - "lastname": { - "description": "The last name of the user", - "example": "Smith", - "type": "string" - }, - "roles": { - "description": "The roles of the user", - "example": "org-level-viewer", - "type": "string" - } - }, - "required": ["email", "email_verified", "firstname", "id", "lastname"], - "x-stoplight": { - "id": "nwug6wvbc5yrp" - } - }, - "UserInfo": { - "description": "Model for User Info", - "examples": [ - { - "email": "user@example.com", - "email_verified": true, - "firstname": "string", - "id": "string", - "lastname": "string", - "roles": null - } - ], - "properties": { - "email": { - "description": "User Email", - "format": "email", - "type": "string" - }, - "email_verified": { - "description": "Set to true if the user's email has been verified.", - "type": "boolean" - }, - "firstname": { - "description": "The firstname of the user", - "type": "string" - }, - "id": { - "description": "User ID", - "type": "string" - }, - "lastname": { - "description": "The lastname of the user", - "type": "string" - }, - "roles": { - "description": "The roles of the user" - } - }, - "title": "User Info Model", - "type": "object", - "x-stoplight": { - "id": "qravubcoxvr6x" - } - }, - "UserList": { - "description": "Model for User List", - "examples": [ - { - "list": [ - { - "email": "user@example.com", - "email_verified": true, - "firstname": "Alice", - "id": "us_8kugj628ebjngs", - "lastname": "Smith", - "roles": "org-level-viewer" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - ], - "title": "User List Model", - "type": "object", - "x-examples": { - "example-1": { - "bases": { - "list": [ - { - "alias": "string", - "database": "string", - "host": "string", - "id": "string", - "params": "string", - "password": "string", - "port": 0, - "project_id": "string", - "ssl": "string", - "type": "string", - "url": "string", - "username": "string" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "pageSize": 0, - "sort": "string", - "totalRows": 0 - } - } - } - }, - "properties": { - "list": { - "type": "array", - "x-stoplight": { - "id": "8o7v47q3e67ef" - }, - "description": "List of user objects", - "items": { - "$ref": "#/components/schemas/User", - "x-stoplight": { - "id": "kwqzxwea9r5er" - } - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated", - "x-stoplight": { - "id": "0d98n6sfxfvft" - }, - "description": "Paginated Info" - } - }, - "required": ["list", "pageInfo"], - "x-stoplight": { - "id": "11epslmm9jcga" - } - }, - "View": { - "description": "Model for View", - "examples": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:46:31", - "fk_model_id": "md_mhs9z4r2ak98x0", - "id": "vw_lg052cnc1c26kf", - "is_default": 1, - "lock_type": "collaborative", - "meta": {}, - "order": 1, - "password": null, - "project_id": "p_xm3thidrblw4n7", - "show": 1, - "show_system_fields": null, - "title": "Sheet-1", - "type": 3, - "updated_at": "2023-03-02 17:46:31", - "uuid": null, - "view": { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:46:31", - "fk_view_id": "vw_lg052cnc1c26kf", - "meta": null, - "project_id": "p_xm3thidrblw4n7", - "row_height": null, - "updated_at": "2023-03-02 17:46:31", - "uuid": null - } - } - ], - "title": "View Model", - "type": "object", - "properties": { - "base_id": { - "$ref": "#/components/schemas/Id", - "description": "Unique Base ID" - }, - "fk_model_id": { - "$ref": "#/components/schemas/Id", - "description": "Unique Model ID" - }, - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID for View" - }, - "lock_type": { - "description": "Lock Type of the view", - "enum": ["collaborative", "locked", "personal"], - "type": "string" - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "description": "Meta data for this view" - }, - "order": { - "description": "The rder of the list of views", - "type": "number" - }, - "password": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Password for protecting the view" - }, - "project_id": { - "$ref": "#/components/schemas/Id", - "description": "Unique Project ID" - }, - "show": { - "$ref": "#/components/schemas/Bool", - "description": "If this view is shown?" - }, - "show_system_fields": { - "$ref": "#/components/schemas/Bool", - "description": "Should show system fields in this view?" - }, - "is_default": { - "$ref": "#/components/schemas/Bool", - "description": "Is this view default view for the model?" - }, - "title": { - "description": "View Title", - "type": "string" - }, - "type": { - "description": "View Type", - "type": "number" - }, - "uuid": { - "$ref": "#/components/schemas/StringOrNull", - "description": "UUID of the view" - }, - "view": { - "anyOf": [ - { - "$ref": "#/components/schemas/Form" - }, - { - "$ref": "#/components/schemas/Gallery" - }, - { - "$ref": "#/components/schemas/Grid" - }, - { - "$ref": "#/components/schemas/Kanban" - }, - { - "$ref": "#/components/schemas/Map" - } - ], - "description": "Associated View Model" - } - }, - "required": ["fk_model_id", "show", "title", "type"], - "x-stoplight": { - "id": "pbahdgaroikdz" - } - }, - "ViewList": { - "description": "Model for View List", - "examples": [ - { - "list": [ - { - "alias": "string", - "column": [ - { - "alias": "string", - "auto_increment": true, - "auto_update_timestamp": true, - "base_id": "string", - "character_maximum_length": "string", - "character_set_name": "string", - "colOptions": { - "deleted": "string", - "dr": "string", - "fk_child_column_id": "string", - "fk_column_id": "string", - "fk_index_name": "string", - "fk_mm_child_column_id": "string", - "fk_mm_model_id": "string", - "fk_mm_parent_column_id": "string", - "fk_parent_column_id": "string", - "id": "string", - "order": "string", - "type": "string", - "ur": "string", - "virtual": true - }, - "column_comment": "string", - "column_default": "string", - "column_ordinal_position": "string", - "column_type": "string", - "data_type": "string", - "data_type_x": "string", - "data_type_x_precision": "string", - "data_type_x_scale": "string", - "deleted": true, - "fk_model_id": "string", - "id": "string", - "numeric_precision": "string", - "numeric_scale": "string", - "order": 0, - "primary_key": true, - "primary_value": true, - "rqd": "string", - "title": "string", - "ui_data_type": "string", - "un": "string", - "unique": true, - "visible": true - } - ], - "columnByIds": {}, - "deleted": true, - "enabled": true, - "fk_base_id": "string", - "fk_project_id": "string", - "id": "string", - "order": 0, - "parent_id": "string", - "pinned": true, - "show_as": "string", - "tags": "string", - "title": "string", - "type": "string" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - ], - "title": "View List Model", - "type": "object", - "x-examples": { - "example-1": { - "bases": { - "list": [ - { - "alias": "string", - "database": "string", - "host": "string", - "id": "string", - "params": "string", - "password": "string", - "port": 0, - "project_id": "string", - "ssl": "string", - "type": "string", - "url": "string", - "username": "string" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "pageSize": 0, - "sort": "string", - "totalRows": 0 - } - } - } - }, - "properties": { - "list": { - "type": "array", - "description": "List of view objects", - "items": { - "$ref": "#/components/schemas/View" - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated", - "description": "Paginated Info" - } - }, - "required": ["list", "pageInfo"], - "x-stoplight": { - "id": "5wwtppugkhbeh" - } - }, - "ViewCreateReq": { - "type": "object", - "x-stoplight": { - "id": "lksv99846uy60" - }, - "title": "ViewCreateReq", - "description": "Model for View Create Request", - "examples": [ - { - "title": "My Grid View", - "type": 3, - "copy_from_id": null, - "fk_grp_col_id": null, - "fk_geo_data_col_id": null - }, - { - "title": "My Gallery View", - "type": 2, - "copy_from_id": null, - "fk_grp_col_id": null, - "fk_geo_data_col_id": null - }, - { - "title": "My Form View", - "type": 1, - "copy_from_id": null, - "fk_grp_col_id": null, - "fk_geo_data_col_id": null - }, - { - "title": "My Kanban View", - "type": 4, - "copy_from_id": null, - "fk_grp_col_id": "cl_g0a89q9xdry3lu", - "fk_geo_data_col_id": null - }, - { - "title": "My Map View", - "type": 5, - "copy_from_id": null, - "fk_grp_col_id": null, - "fk_geo_data_col_id": "cl_uu1meolj00tlrq" - } - ], - "properties": { - "title": { - "type": "string", - "description": "View Title", - "example": "My View" - }, - "type": { - "type": "number", - "description": "View Type" - }, - "copy_from_id": { - "$ref": "#/components/schemas/StringOrNull", - "description": "ID of view to be copied from. Used in Copy View." - }, - "fk_grp_col_id": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Foreign Key to Grouping Column. Used in creating Kanban View." - }, - "fk_geo_data_col_id": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Foreign Key to Geo Data Column. Used in creating Map View." - } - }, - "required": ["title"] - }, - "ViewUpdateReq": { - "description": "Model for View Update Request", - "x-stoplight": { - "id": "1enlswadfc6p5" - }, - "examples": [ - { - "title": "Grid View 1", - "uuid": "e2457bbf-e29c-4fec-866e-fe3b01dba57f", - "password": "password123", - "lock_type": "collaborative", - "meta": "{\"allowCSVDownload\":true}", - "order": 1, - "show_system_fields": 0 - } - ], - "title": "View Update Request Model", - "type": "object", - "properties": { - "title": { - "maxLength": 255, - "type": "string", - "description": "View Title", - "example": "Grid View 1" - }, - "uuid": { - "maxLength": 255, - "type": "string", - "x-stoplight": { - "id": "vlhs7xs644u8l" - }, - "description": "View UUID. Used in Shared View.", - "example": "e2457bbf-e29c-4fec-866e-fe3b01dba57f" - }, - "password": { - "maxLength": 255, - "type": "string", - "x-stoplight": { - "id": "vlhs7xs644u8l" - }, - "description": "View Password. Used in Shared View.", - "example": "password123" - }, - "lock_type": { - "enum": ["collaborative", "locked", "personal"], - "type": "string", - "description": "Lock type of View.", - "example": "collaborative" - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "description": "Meta info used in View." - }, - "order": { - "type": "number", - "description": "The order of the list of views.", - "example": 1, - "minimum": 0 - }, - "show_system_fields": { - "$ref": "#/components/schemas/Bool", - "description": "Should this view show system fields?" - } - } - }, - "ViewColumnUpdateReq": { - "description": "Model for View Column Update Request", - "x-stoplight": { - "id": "ifzuv29axterb" - }, - "examples": [ - { - "show": 0, - "order": 1 - } - ], - "title": "View Column Update Request Model", - "type": "object", - "properties": { - "show": { - "$ref": "#/components/schemas/Bool", - "description": "View Title", - "x-stoplight": { - "id": "coxius73ejq5x" - } - }, - "order": { - "type": "number", - "description": "The order of the list of views.", - "example": 1, - "minimum": 0 - } - } - }, - "ViewColumnReq": { - "description": "Model for View Column Request", - "x-stoplight": { - "id": "z4bq84nyqkhd8" - }, - "examples": [ - { - "fk_column_id": "cl_5jestblzneb649", - "show": 0, - "order": 1 - } - ], - "title": "View Column Request Model", - "type": "object", - "properties": { - "fk_column_id": { - "$ref": "#/components/schemas/Id", - "x-stoplight": { - "id": "rxd07wvp9hf6s" - }, - "description": "Foreign Key to Column" - }, - "show": { - "$ref": "#/components/schemas/Bool", - "description": "View Title", - "x-stoplight": { - "id": "coxius73ejq5x" - } - }, - "order": { - "type": "number", - "description": "The order of the list of views.", - "example": 1, - "minimum": 0 - } - } - }, - "VisibilityRuleReq": { - "description": "Model for Visibility Rule Request", - "examples": [ - [ - { - "disabled": { - "commenter": true, - "creator": true, - "editor": true, - "guest": true, - "owner": true, - "viewer": true - } - } - ] - ], - "items": { - "properties": { - "id": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "disabled": { - "properties": { - "commenter": { - "$ref": "#/components/schemas/Bool" - }, - "creator": { - "$ref": "#/components/schemas/Bool" - }, - "editor": { - "$ref": "#/components/schemas/Bool" - }, - "guest": { - "$ref": "#/components/schemas/Bool" - }, - "owner": { - "$ref": "#/components/schemas/Bool" - }, - "viewer": { - "$ref": "#/components/schemas/Bool" - } - }, - "type": "object" - } - }, - "type": "object" - }, - "title": "Visibility Rule Request Model", - "type": "array", - "x-stoplight": { - "id": "vuo5q4vwtarx8" - } - } - }, - "responses": { - "ProjectList": { - "description": "Example response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProjectList" - }, - "examples": { - "example-1": { - "value": { - "list": [ - { - "bases": [ - { - "alias": "string", - "config": null, - "created_at": "2023-03-01 14:27:36", - "enabled": true, - "id": "string", - "inflection_column": "camelize", - "inflection_table": "camelize", - "is_meta": true, - "order": 1, - "project_id": "string", - "type": "mysql2", - "updated_at": "2023-03-01 14:27:36" - } - ], - "color": "#24716E", - "created_at": "2023-03-01 14:27:36", - "deleted": true, - "description": "This is my project description", - "id": "p_124hhlkbeasewh", - "is_meta": true, - "meta": {}, - "order": 0, - "prefix": "nc_vm5q__", - "status": "string", - "title": "my-project", - "updated_at": "2023-03-01 14:27:36" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "BaseList": { - "description": "Example response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BaseList" - }, - "examples": { - "example-1": { - "value": { - "list": [ - { - "id": "ds_krsappzu9f8vmo", - "project_id": "p_01clqvzik3izk6", - "alias": null, - "config": "", - "meta": null, - "is_meta": 1, - "type": "mysql2", - "inflection_column": "camelize", - "inflection_table": "camelize", - "created_at": "2023-03-01 16:31:49", - "updated_at": "2023-03-02 11:28:17", - "enabled": 1, - "order": 1 - }, - { - "id": "ds_btbdt19zde0gj9", - "project_id": "p_01clqvzik3izk6", - "alias": "sakila", - "config": "", - "meta": null, - "is_meta": null, - "type": "mysql2", - "inflection_column": "camelize", - "inflection_table": "camelize", - "created_at": "2023-03-02 11:28:17", - "updated_at": "2023-03-02 11:28:17", - "enabled": 1, - "order": 2 - } - ], - "pageInfo": { - "totalRows": 2, - "page": 1, - "pageSize": 2, - "isFirstPage": true, - "isLastPage": true - } - } - } - } - } - } - }, - "TableList": { - "description": "Example response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TableList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "id": "md_5hua2iqloqirhd", - "base_id": "ds_jxuewivwbxeum2", - "project_id": "p_tbhl1hnycvhe5l", - "table_name": "nc_b84e___Sheet-1", - "title": "Sheet-1", - "type": "table", - "meta": null, - "schema": null, - "enabled": true, - "mm": false, - "tags": null, - "pinned": null, - "deleted": null, - "order": 1, - "created_at": "2023-03-11T09:11:45.907Z", - "updated_at": "2023-03-11T09:11:45.907Z" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "ColumnList": { - "description": "Example response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ColumnList" - } - } - } - }, - "FilterList": { - "description": "Example response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FilterList" - } - } - } - }, - "SortList": { - "description": "Example response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SortList" - }, - "examples": {} - } - } - }, - "ViewList": { - "description": "Example response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ViewList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "alias": "string", - "column": [ - { - "alias": "string", - "auto_increment": true, - "auto_update_timestamp": true, - "base_id": "string", - "character_maximum_length": "string", - "character_set_name": "string", - "colOptions": { - "deleted": "string", - "dr": "string", - "fk_child_column_id": "string", - "fk_column_id": "string", - "fk_index_name": "string", - "fk_mm_child_column_id": "string", - "fk_mm_model_id": "string", - "fk_mm_parent_column_id": "string", - "fk_parent_column_id": "string", - "id": "string", - "order": "string", - "type": "string", - "ur": "string", - "virtual": true - }, - "column_comment": "string", - "column_default": "string", - "column_ordinal_position": "string", - "column_type": "string", - "data_type": "string", - "data_type_x": "string", - "data_type_x_precision": "string", - "data_type_x_scale": "string", - "deleted": true, - "fk_model_id": "string", - "id": "string", - "numeric_precision": "string", - "numeric_scale": "string", - "order": 0, - "primary_key": true, - "primary_value": true, - "rqd": "string", - "title": "string", - "ui_data_type": "string", - "un": "string", - "unique": true, - "visible": true - } - ], - "columnByIds": {}, - "deleted": true, - "enabled": true, - "fk_base_id": "string", - "fk_project_id": "string", - "id": "string", - "order": 0, - "parent_id": "string", - "pinned": true, - "show_as": "string", - "tags": "string", - "title": "string", - "type": "string" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "SharedViewList": { - "description": "Example response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SharedViewList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:46:31", - "fk_model_id": "md_mhs9z4r2ak98x0", - "id": "vw_lg052cnc1c26kf", - "is_default": 1, - "lock_type": "collaborative", - "meta": {}, - "order": 1, - "password": null, - "project_id": "p_xm3thidrblw4n7", - "show": 1, - "show_system_fields": null, - "title": "Sheet-1", - "type": 3, - "updated_at": "2023-03-02 17:46:31", - "uuid": null, - "view": { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:46:31", - "fk_view_id": "vw_lg052cnc1c26kf", - "meta": null, - "project_id": "p_xm3thidrblw4n7", - "row_height": null, - "updated_at": "2023-03-02 17:46:31", - "uuid": null - } - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "HookList": { - "description": "Example response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HookList" - } - } - } - }, - "UserList": { - "description": "Example response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UserList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "email": "user@example.com", - "email_verified": true, - "firstname": "Alice", - "id": "us_8kugj628ebjngs", - "lastname": "Smith", - "roles": "org-level-viewer" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "APITokenList": { - "description": "Example response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiTokenList" - }, - "examples": {} - } - }, - "type": "object", - "properties": { - "list": { - "type": "array", - "x-stoplight": { - "id": "uukp6v55zfp7i" - }, - "items": { - "$ref": "#/components/schemas/ApiToken", - "x-stoplight": { - "id": "9zqpoqfkdxy0y" - } - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated", - "x-stoplight": { - "id": "6unr17jyisial" - } - } - } - }, - "BadRequest": { - "description": "BadReqeust", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "p9mk4oi0hbihm" - }, - "example": "BadRequest [Error]: " - } - }, - "required": ["msg"] - }, - "examples": { - "Example 1": { - "value": { - "msg": "BadRequest [Error]: " - } - } - } - } - }, - "headers": {} - } - }, - "securitySchemes": { - "xc-auth": { - "name": "Auth Token ", - "type": "apiKey", - "in": "header", - "description": "Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable `NC_JWT_EXPIRES_IN`." - }, - "xc-shared-base-id": { - "name": "Shared Base ID", - "type": "apiKey", - "in": "header", - "description": "Shared base uuid" - } - }, - "parameters": { - "xc-auth": { - "name": "xc-auth", - "in": "header", - "required": false, - "schema": { - "type": "string" - }, - "description": "Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN." - } - } - } -}{ - "openapi": "3.1.0", - "info": { - "title": "nocodb", - "version": "1.0", - "description": "NocoDB API Documentation" - }, - "x-tagGroups": [ - { - "name": "Auth APIs", - "tags": ["Auth", "API Token"] - }, - { - "name": "Public APIs", - "tags": ["Public"] - }, - { - "name": "Data APIs", - "tags": ["DB Table Row", "DB View Row", "Storage"] - }, - { - "name": "Meta APIs", - "tags": [ - "Base", - "DB Table", - "DB Table Column", - "DB Table Filter", - "DB Table Sort", - "DB Table Webhook", - "DB Table Webhook Filter", - "DB View", - "DB View Column", - "DB View Share", - "Plugin", - "Project", - "Utils" - ] - }, - { - "name": "Organisation APIs", - "tags": ["Org App Settings", "Org License", "Org Tokens", "Org Users"] - } - ], - "servers": [ - { - "url": "http://localhost:8080" - } - ], - "paths": { - "/api/v1/auth/user/signup": { - "post": { - "summary": "Signup", - "operationId": "auth-signup", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "token": { - "type": "string", - "description": "The signed JWT token for information exchange", - "example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbWFpbCI6IndAbm9jb2RiLmNvbSIsImZpcnN0bmFtZSI6bnVsbCwibGFzdG5hbWUiOm51bGwsImlkIjoidXNfYjN4bzJpNDRueDV5OWwiLCJyb2xlcyI6Im9yZy1sZXZlbC1jcmVhdG9yLHN1cGVyIiwidG9rZW5fdmVyc2lvbiI6ImJmMTc3ZGUzYjk3YjAzMjY4YjU0NGZmMjMzNGU5YjFhMGUzYzgxM2NiYzliOTJkYWMwYmM5NTRiNmUzN2ZjMTJjYmFkNDM2NmIwYzExZTdjIiwiaWF0IjoxNjc4MDc4NDMyLCJleHAiOjE2NzgxMTQ0MzJ9.gzwp_svZlbA5PV_eawYV-9UFjZVjniy-tCDce16xrkI" - } - } - }, - "examples": { - "Example 1": { - "value": { - "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbWFpbCI6IndAbm9jb2RiLmNvbSIsImZpcnN0bmFtZSI6bnVsbCwibGFzdG5hbWUiOm51bGwsImlkIjoidXNfYjN4bzJpNDRueDV5OWwiLCJyb2xlcyI6Im9yZy1sZXZlbC1jcmVhdG9yLHN1cGVyIiwidG9rZW5fdmVyc2lvbiI6ImJmMTc3ZGUzYjk3YjAzMjY4YjU0NGZmMjMzNGU5YjFhMGUzYzgxM2NiYzliOTJkYWMwYmM5NTRiNmUzN2ZjMTJjYmFkNDM2NmIwYzExZTdjIiwiaWF0IjoxNjc4MDc4NDMyLCJleHAiOjE2NzgxMTQ0MzJ9.gzwp_svZlbA5PV_eawYV-9UFjZVjniy-tCDce16xrkI" - } - } - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string" - } - } - }, - "examples": { - "Invalid email": { - "value": { - "msg": "Invalid email" - } - }, - "Invalid invite url": { - "value": { - "msg": "Invalid invite url" - } - }, - "Expired invite url": { - "value": { - "msg": "Expired invite url, Please contact super admin to get a new invite url" - } - }, - "User already exist": { - "value": { - "msg": "User already exist" - } - }, - "Invite only signup": { - "value": { - "msg": "Not allowed to signup, contact super admin" - } - } - } - } - } - } - }, - "tags": ["Auth"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SignUpReq" - }, - "examples": { - "Example 1": { - "value": { - "email": "user@example.com", - "password": "password123456789", - "firstname": "Alice", - "lastname": "Smith", - "token": null, - "ignore_subscribe": 0 - } - } - } - } - } - }, - "description": "Create a new user with provided email and password and first user is marked as super admin. " - } - }, - "/api/v1/auth/user/signout": { - "post": { - "summary": "Signout", - "operationId": "auth-signout", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "description": "Success Message", - "example": "Signed out successfully" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "Signed out successfully" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Auth"], - "description": "Clear refresh token from the database and cookie." - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "/api/v1/auth/user/signin": { - "post": { - "summary": "Signin", - "operationId": "auth-signin", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "token": { - "type": "string", - "description": "The signed JWT token for information exchange", - "example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbWFpbCI6IndAbm9jb2RiLmNvbSIsImZpcnN0bmFtZSI6bnVsbCwibGFzdG5hbWUiOm51bGwsImlkIjoidXNfYjN4bzJpNDRueDV5OWwiLCJyb2xlcyI6Im9yZy1sZXZlbC1jcmVhdG9yLHN1cGVyIiwidG9rZW5fdmVyc2lvbiI6ImJmMTc3ZGUzYjk3YjAzMjY4YjU0NGZmMjMzNGU5YjFhMGUzYzgxM2NiYzliOTJkYWMwYmM5NTRiNmUzN2ZjMTJjYmFkNDM2NmIwYzExZTdjIiwiaWF0IjoxNjc4MDc4NDMyLCJleHAiOjE2NzgxMTQ0MzJ9.gzwp_svZlbA5PV_eawYV-9UFjZVjniy-tCDce16xrkI" - } - } - }, - "examples": { - "Example 1": { - "value": { - "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbWFpbCI6IndAbm9jb2RiLmNvbSIsImZpcnN0bmFtZSI6bnVsbCwibGFzdG5hbWUiOm51bGwsImlkIjoidXNfYjN4bzJpNDRueDV5OWwiLCJyb2xlcyI6Im9yZy1sZXZlbC1jcmVhdG9yLHN1cGVyIiwidG9rZW5fdmVyc2lvbiI6ImJmMTc3ZGUzYjk3YjAzMjY4YjU0NGZmMjMzNGU5YjFhMGUzYzgxM2NiYzliOTJkYWMwYmM5NTRiNmUzN2ZjMTJjYmFkNDM2NmIwYzExZTdjIiwiaWF0IjoxNjc4MDc4NDMyLCJleHAiOjE2NzgxMTQ0MzJ9.gzwp_svZlbA5PV_eawYV-9UFjZVjniy-tCDce16xrkI" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Auth"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SignInReq" - }, - "examples": { - "example-1": { - "value": { - "email": "user@example.com", - "password": "Password" - } - } - } - } - } - }, - "description": "Authenticate existing user with their email and password. Successful login will return a JWT access-token. " - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "/api/v1/auth/user/me": { - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "get": { - "summary": "Get User Info", - "operationId": "auth-me", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UserInfo" - }, - "examples": { - "example-1": { - "value": { - "id": "us_8kugj628ebjngs", - "email": "user@example.com", - "email_verified": true, - "firstname": "Alice", - "lastname": "Smith", - "roles": "org-level-viewer" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Auth"], - "description": "Returns authenticated user info", - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id" - }, - "in": "query", - "name": "project_id", - "description": "Pass project id to get project specific roles along with user info" - } - ] - } - }, - "/api/v1/auth/password/forgot": { - "post": { - "summary": "Forget Password", - "operationId": "auth-password-forgot", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "q9s5vh2i34x6c" - }, - "example": "Please check your email to reset the password", - "description": "Success Message" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "Please check your email to reset the password" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Emails user with a reset url.", - "tags": ["Auth"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PasswordForgotReq" - }, - "examples": { - "Example 1": { - "value": { - "email": "user@example.com" - } - } - } - } - }, - "description": "Pass registered user email id in request body" - } - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "/api/v1/auth/password/change": { - "post": { - "summary": "Change Password", - "operationId": "auth-password-change", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "description": "Success Message" - } - } - }, - "examples": { - "Success response": { - "value": { - "msg": "Password has been updated successfully" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Change password of authenticated user with a new one.", - "tags": ["Auth"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PasswordChangeReq" - }, - "examples": { - "example-1": { - "value": { - "currentPassword": "currentPassword", - "newPassword": "newPassword" - } - } - } - } - }, - "description": "Old password need to be passed along with new password for changing password." - } - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "/api/v1/auth/token/validate/{token}": { - "post": { - "summary": "Verify Reset Token", - "operationId": "auth-password-reset-token-validate", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "unxdsok22kg1y" - }, - "example": "Token has been validated successfully", - "description": "Success Message" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "Token has been validated successfully" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Validate password reset url token.", - "tags": ["Auth"], - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "parameters": [ - { - "schema": { - "type": "string", - "format": "uuid", - "example": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11" - }, - "name": "token", - "in": "path", - "required": true, - "description": "Reset Token" - } - ] - }, - "/api/v1/auth/email/validate/{token}": { - "post": { - "summary": "Verify Email", - "operationId": "auth-email-validate", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "u49sbr20s9rgf" - }, - "description": "Success Message", - "example": "Email has been verified successfully" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "Email has been verified successfully" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Api for verifying email where token need to be passed which is shared to user email.", - "tags": ["Auth"], - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "parameters": [ - { - "schema": { - "type": "string", - "format": "uuid", - "example": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11" - }, - "name": "token", - "in": "path", - "required": true, - "description": "Validation Token" - } - ] - }, - "/api/v1/auth/password/reset/{token}": { - "post": { - "summary": "Reset Password", - "operationId": "auth-password-reset", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "2to6ro4121rfx" - }, - "description": "Success Message", - "example": "Password has been reset successfully" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "Password has been reset successfully" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Update user password to new by using reset token.", - "tags": ["Auth"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PasswordResetReq" - }, - "examples": { - "Example 1": { - "value": { - "password": "newpassword" - } - } - } - } - } - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "parameters": [ - { - "schema": { - "type": "string", - "format": "uuid", - "example": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11" - }, - "name": "token", - "in": "path", - "required": true, - "description": "Reset Password Token" - } - ] - }, - "/api/v1/auth/token/refresh": { - "post": { - "summary": "Refresh Token", - "operationId": "auth-token-refresh", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "token": { - "type": "string", - "description": "New access token for user", - "example": "96751db2d53fb834382b682268874a2ea9ee610e4d904e688d1513f11d3c30d62d36d9e05dec0d63" - } - } - }, - "examples": { - "Example 1": { - "value": { - "token": "96751db2d53fb834382b682268874a2ea9ee610e4d904e688d1513f11d3c30d62d36d9e05dec0d63" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Regenerate user refresh token", - "tags": ["Auth"], - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "/api/v1/tokens": { - "get": { - "summary": "List Organisation API Tokens", - "operationId": "org-tokens-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiTokenList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "id": "1", - "fk_user_id": "us_b3xo2i44nx5y9l", - "description": "This API Token is for ABC application", - "token": "DYh540o8hbWpUGdarekECKLdN5OhlgCUWutVJYX2" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "List all organisation API tokens. Access with API tokens will be blocked.", - "tags": ["Org Tokens"], - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "post": { - "summary": "Create Organisation API Token", - "operationId": "org-tokens-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiToken" - }, - "examples": { - "Example 1": { - "value": { - "id": "1", - "fk_user_id": "us_b3xo2i44nx5y9l", - "description": "This API Token is for ABC application", - "token": "DYh540o8hbWpUGdarekECKLdN5OhlgCUWutVJYX2" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiTokenReq" - }, - "examples": { - "Example 1": { - "value": { - "description": "This API token is for ABC application" - } - } - } - } - } - }, - "tags": ["Org Tokens"], - "description": "Creat an organisation API token. Access with API tokens will be blocked." - } - }, - "/api/v1/tokens/{token}": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "token", - "in": "path", - "required": true, - "description": "API Token" - } - ], - "delete": { - "summary": "Delete Organisation API Tokens", - "operationId": "org-tokens-delete", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number", - "example": 1 - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Org Tokens"], - "description": "Delete an organisation API token. Access with API tokens will be blocked.", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/license": { - "get": { - "summary": "Get App License", - "operationId": "org-license-get", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Application license key" - } - } - }, - "examples": { - "Example 1": { - "value": { - "key": "195f7bcc-c3e1-43c5-b23c-8d8127280e7d" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Get the application license key. Exclusive for super admin.", - "tags": ["Org License"], - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "post": { - "summary": "Create App License", - "operationId": "org-license-set", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "wsiywigeb9hjl" - }, - "example": "The license key has been saved" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "The license key has been saved" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/LicenseReq" - }, - "examples": { - "Example 1": { - "value": { - "key": "1234567890" - } - } - } - } - } - }, - "tags": ["Org License"], - "description": "Set the application license key. Exclusive for super admin.", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/app-settings": { - "get": { - "summary": "Get App Settings", - "operationId": "org-app-settings-get", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "invite_only_signup": { - "type": "boolean", - "description": "Status of invite only signup", - "example": true - } - } - }, - "examples": { - "Example 1": { - "value": { - "invite_only_signup": true - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Get the application settings. Exclusive for super admin.", - "tags": ["Org App Settings"], - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "post": { - "summary": "Create App Settings", - "operationId": "org-app-settings-set", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "6qbh8ijtc4tva" - }, - "example": "The app settings have been saved" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "The app settings have been saved" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "invite_only_signup": { - "type": "boolean", - "description": "Status of invite only signup", - "example": true - } - } - }, - "examples": { - "Example 1": { - "value": { - "invite_only_signup": true - } - } - } - } - } - }, - "tags": ["Org App Settings"], - "description": "Update the application settings. Exclusive for super admin.", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/users": { - "get": { - "summary": "List Organisation Users", - "operationId": "org-users-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UserList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "email": "user@example.com", - "email_verified": true, - "firstname": "Alice", - "id": "us_8kugj628ebjngs", - "lastname": "Smith", - "roles": "org-level-viewer" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "List all organisation users. Exclusive for Super Admin. Access with API Tokens will be blocked.", - "tags": ["Org Users"], - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "post": { - "summary": "Create Organisation User", - "operationId": "org-users-add", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "x-examples": { - "Example 1": { - "invite_token": "c22c129f-d947-4030-a838-1b498fce21bb", - "email": "w123@nocodb.com" - } - }, - "properties": { - "invite_token": { - "type": "string", - "description": "Invite Token" - }, - "email": { - "type": "string", - "description": "User email", - "example": "user@example.com" - } - } - }, - "examples": { - "Example 1": { - "value": { - "invite_token": "c22c129f-d947-4030-a838-1b498fce21bb", - "email": "user@example.com" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/OrgUserReq" - }, - "examples": { - "Example 1": { - "value": { - "email": "user@example.com", - "roles": "org-level-creator" - } - } - } - } - } - }, - "tags": ["Org Users"], - "description": "Create an organisation user. Exclusive for Super Admin. Access with API Tokens will be blocked.", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/users/{userId}": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "us_b3xo2i44nx5y9l" - }, - "name": "userId", - "in": "path", - "required": true, - "description": "Unique User ID" - } - ], - "patch": { - "summary": "Update Organisation User", - "operationId": "org-users-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "6oa45bkw7j57j" - }, - "example": "The user has been updated successfully" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "The user has been updated successfully" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Org Users"], - "description": "Update an organisation user by User ID. Exclusive for Super Admin. Access with API Tokens will be blocked.", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/OrgUserReq" - }, - "examples": { - "Example 1": { - "value": { - "email": "user@example.com", - "roles": "org-level-creator" - } - } - } - } - }, - "description": "" - } - }, - "delete": { - "summary": "Delete Organisation User", - "operationId": "org-users-delete", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "buvrqjvv255tf" - }, - "example": "The user has been deleted successfully", - "description": "Sucess Message" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "The user has been deleted successfully" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Org Users"], - "description": "Delete an organisation user by User ID. Exclusive for Super Admin. Access with API Tokens will be blocked." - } - }, - "/api/v1/users/{userId}/resend-invite": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "us_b3xo2i44nx5y9l" - }, - "name": "userId", - "in": "path", - "required": true, - "description": "Unique User ID" - } - ], - "post": { - "summary": "Invite Organisation User", - "operationId": "org-users-resend-invite", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "aixfqd9jfh5pq" - }, - "example": "The invitation has been sent to the target user", - "description": "Success Message" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "The invitation has been sent to the target user" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Org Users"], - "description": "Resend Invitation to a specific user. Exclusive for Super Admin. Access with API Tokens will be blocked.", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/users/{userId}/generate-reset-url": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "us_b3xo2i44nx5y9l" - }, - "name": "userId", - "in": "path", - "required": true, - "description": "Unique User ID" - } - ], - "post": { - "summary": "Generate Organisation User Password Reset Token", - "operationId": "org-users-generate-password-reset-token", - "tags": ["Org Users"], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "reset_password_token": { - "type": "string", - "description": "Password Reset Token for the user" - }, - "reset_password_url": { - "type": "string", - "description": "Password Reset URL for the user" - } - } - }, - "examples": { - "Example 1": { - "value": { - "reset_password_token": "string", - "reset_password_url": "string" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Generate Password Reset Token for Organisation User. Exclusive for Super Admin. Access with API Tokens will be blocked.", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/projects/{projectId}/users": { - "get": { - "summary": "List Project Users", - "operationId": "auth-project-user-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "users": { - "type": "object", - "properties": { - "list": { - "type": "array", - "uniqueItems": true, - "minItems": 1, - "items": { - "$ref": "#/components/schemas/User" - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated" - } - }, - "required": ["list", "pageInfo"] - } - } - }, - "examples": { - "Example 1": { - "value": { - "users": { - "list": [ - { - "email": "user@example.com", - "email_verified": true, - "firstname": "Alice", - "id": "us_8kugj628ebjngs", - "lastname": "Smith", - "roles": "org-level-viewer" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "List all users in the given project.", - "tags": ["Auth"], - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - } - ], - "post": { - "summary": "Create Project User", - "operationId": "auth-project-user-add", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "waau9tvy75zsd" - }, - "description": "Success Message for inviting single email", - "example": "The user has been invited successfully" - }, - "invite_token": { - "type": "string", - "x-stoplight": { - "id": "yx0s35u8ds3p7" - }, - "example": "8354ddba-a769-4d64-8397-eccb2e2b3c06" - }, - "error": { - "type": "array", - "x-stoplight": { - "id": "yhfi6wzhr6zr1" - }, - "items": { - "x-stoplight": { - "id": "ce0hlv3d0f96j" - }, - "type": "object", - "properties": { - "email": { - "type": "string", - "x-stoplight": { - "id": "dgnh01j4lxvl1" - }, - "example": "w@nocodb.com" - }, - "error": { - "type": "string", - "x-stoplight": { - "id": "7dgttqiijg8no" - }, - "example": "" - } - } - } - }, - "email": { - "type": "string", - "x-stoplight": { - "id": "08pqst2q30vot" - }, - "example": "w@nocodb.com" - } - } - }, - "examples": { - "Inviting a user without any errors": { - "value": { - "msg": "The user has been invited successfully" - } - }, - "Inviting a user but invitation email failed to send": { - "value": { - "invite_token": "8354ddba-a769-4d64-8397-eccb2e2b3c06", - "email": "w@nocodb.com" - } - }, - "Inviting multiple users": { - "value": { - "invite_token": "8354ddba-a769-4d64-8397-eccb2e2b3c06", - "error": [ - { - "email": "w@nocodb.com", - "error": "" - } - ] - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProjectUserReq" - }, - "examples": { - "Example 1": { - "value": { - "email": "user@example.com", - "roles": "owner" - } - } - } - } - } - }, - "tags": ["Auth"], - "description": "Create a user and add it to the given project", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/projects/{projectId}/info": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - } - ], - "get": { - "summary": "Get Project info", - "operationId": "project-meta-get", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "Node": { - "type": "string", - "description": "Node version", - "example": "v12.16.1" - }, - "Arch": { - "type": "string", - "description": "Architecture type", - "example": "x64" - }, - "Platform": { - "type": "string", - "description": "Platform type", - "example": "linux" - }, - "Docker": { - "type": "boolean", - "description": "Is docker", - "example": false - }, - "Database": { - "type": "string", - "description": "Database type", - "example": "postgres" - }, - "ProjectOnRootDB": { - "type": "boolean", - "description": "Is project on rootdb", - "example": false - }, - "RootDB": { - "type": "string", - "description": "Root database type", - "example": "postgres" - }, - "PackageVersion": { - "type": "string", - "description": "Package version", - "example": "1.0.0" - } - } - }, - "examples": { - "Example 1": { - "value": { - "Node": "v12.16.1", - "Arch": "x64", - "Platform": "linux", - "Docker": false, - "Database": "postgres", - "ProjectOnRootDB": false, - "RootDB": "postgres", - "PackageVersion": "1.0.0" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Project"], - "description": "Get info such as node version, arch, platform, is docker, rootdb and package version of a given project", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/projects/{projectId}/users/{userId}": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - }, - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "us_b3xo2i44nx5y9l" - }, - "name": "userId", - "in": "path", - "required": true, - "description": "Unique User ID" - } - ], - "patch": { - "summary": "Update Project User", - "operationId": "auth-project-user-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "5a2q8as60daly" - }, - "description": "Success Message", - "example": "The user has been updated successfully" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "The user has been updated successfully" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProjectUserReq" - }, - "examples": { - "Example 1": { - "value": { - "email": "user@example.com", - "roles": "owner" - } - } - } - } - } - }, - "tags": ["Auth"], - "description": "Update a given user in a given project. Exclusive for Super Admin. Access with API Tokens will be blocked.", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "delete": { - "summary": "Delete Project User", - "operationId": "auth-project-user-remove", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "5h7c9lqh5ynve" - }, - "example": "The user has been updated successfully", - "description": "Success Message" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "The user has been updated successfully" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Auth"], - "description": "Delete a given user in a given project. Exclusive for Super Admin. Access with API Tokens will be blocked.", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/projects/{projectId}/visibility-rules": { - "get": { - "summary": "Get UI ACL", - "operationId": "project-model-visibility-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": {} - }, - "examples": { - "Example 1": { - "value": [ - { - "ptn": "nc_09gt___Sheet-1", - "_ptn": "Sheet-1", - "ptype": "table", - "tn": "Sheet-1", - "_tn": "Sheet-1", - "table_meta": null, - "id": "vw_75neroyqdye94k", - "base_id": "ds_eol59jg2l4zwev", - "project_id": "p_63b4q0qengen1x", - "fk_model_id": "md_5mipbdg6ketmv8", - "title": "Sheet-1", - "type": 3, - "is_default": true, - "show_system_fields": null, - "lock_type": "collaborative", - "uuid": "24a6d0bb-e45d-4b1a-bfef-f492d870de9f", - "password": null, - "show": true, - "order": 1, - "created_at": "2023-03-08T10:44:55.253Z", - "updated_at": "2023-03-10T07:18:44.908Z", - "meta": { - "allowCSVDownload": true - }, - "view": { - "fk_view_id": "vw_75neroyqdye94k", - "base_id": "ds_eol59jg2l4zwev", - "project_id": "p_63b4q0qengen1x", - "uuid": null, - "created_at": "2023-03-08T10:44:55.288Z", - "updated_at": "2023-03-08T10:44:55.288Z", - "meta": null, - "row_height": null - }, - "disabled": { - "owner": false, - "creator": false, - "viewer": false, - "editor": false, - "commenter": false, - "guest": false - } - } - ] - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Hide / show views based on user role", - "tags": ["Project"], - "parameters": [ - { - "schema": { - "type": "boolean" - }, - "in": "query", - "name": "includeM2M" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - } - ], - "post": { - "summary": "Create UI ACL", - "operationId": "project-model-visibility-set", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "2txh071wsodys" - }, - "example": "UI ACL has been created successfully" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "UI ACL has been created successfully" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VisibilityRuleReq" - } - } - } - }, - "tags": ["Project"], - "description": "Hide / show views based on user role", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/projects/": { - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "get": { - "summary": "List Projects", - "operationId": "project-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProjectList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "bases": [ - { - "alias": "string", - "config": null, - "created_at": "2023-03-01 14:27:36", - "enabled": true, - "id": "string", - "inflection_column": "camelize", - "inflection_table": "camelize", - "is_meta": true, - "order": 1, - "project_id": "string", - "type": "mysql2", - "updated_at": "2023-03-01 14:27:36" - } - ], - "color": "#24716E", - "created_at": "2023-03-01 14:27:36", - "deleted": true, - "description": "This is my project description", - "id": "p_124hhlkbeasewh", - "is_meta": true, - "meta": {}, - "order": 0, - "prefix": "nc_vm5q__", - "status": "string", - "title": "my-project", - "updated_at": "2023-03-01 14:27:36" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "List all project meta data", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["Project"] - }, - "post": { - "summary": "Create Project", - "operationId": "project-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProjectReq" - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/Project" - }, - { - "type": "object", - "properties": { - "external": { - "type": "boolean", - "default": false, - "description": "If true, the project will us an external database else it will use the root database" - } - } - } - ] - }, - "examples": { - "Example 1": { - "value": { - "bases": [ - { - "alias": "string", - "config": null, - "enabled": true, - "id": "string", - "inflection_column": "camelize", - "inflection_table": "camelize", - "is_meta": true, - "order": 1, - "project_id": "string", - "type": "mysql2", - "updated_at": "2023-03-01 14:27:36" - } - ], - "color": "#24716E", - "created_at": "2023-03-01 14:27:36", - "deleted": true, - "description": "This is my project description", - "id": "p_124hhlkbeasewh", - "is_meta": true, - "meta": {}, - "order": 0, - "prefix": "nc_vm5q__", - "status": "string", - "title": "my-project", - "external": false - } - } - } - } - } - }, - "tags": ["Project"], - "description": "Create a new project", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/projects/{projectId}": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - } - ], - "get": { - "summary": "Get Project", - "operationId": "project-read", - "description": "Get the info of a given project", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["Project"], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Project" - }, - "examples": { - "Example 1": { - "value": { - "bases": [ - { - "alias": "string", - "config": null, - "enabled": true, - "id": "string", - "inflection_column": "camelize", - "inflection_table": "camelize", - "is_meta": true, - "order": 1, - "project_id": "string", - "type": "mysql2", - "updated_at": "2023-03-01 14:27:36" - } - ], - "color": "#24716E", - "created_at": "2023-03-01 14:27:36", - "deleted": true, - "description": "This is my project description", - "id": "p_124hhlkbeasewh", - "is_meta": true, - "meta": {}, - "order": 0, - "prefix": "nc_vm5q__", - "status": "string", - "title": "my-project" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - } - }, - "delete": { - "summary": "Delete Project", - "operationId": "project-delete", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "boolean" - }, - "examples": { - "Example 1": { - "value": true - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Project"], - "description": "Delete the given project", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "patch": { - "summary": "Update Project", - "operationId": "project-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number", - "example": 1 - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Project"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProjectUpdateReq" - }, - "examples": { - "Example 1": { - "value": { - "color": "#24716E", - "meta": null, - "title": "My Project" - } - } - } - } - } - }, - "description": "Update the given project", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/projects/{projectId}/bases/{baseId}": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - }, - { - "schema": { - "type": "string", - "pattern": "ds_j04jmxh5xg10lu" - }, - "name": "baseId", - "in": "path", - "required": true, - "description": "Unique Base ID" - } - ], - "get": { - "summary": "Get Base", - "operationId": "base-read", - "description": "Get the base details of a given project", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["Base"], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Base" - }, - "examples": { - "Example 1": { - "value": { - "alias": null, - "config": "", - "enabled": 1, - "id": "ds_krsappzu9f8vmo", - "inflection_column": "camelize", - "inflection_table": "camelize", - "is_meta": 1, - "meta": null, - "order": 1, - "project_id": "p_01clqvzik3izk6", - "type": "mysql2" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - } - }, - "delete": { - "summary": "Delete Base", - "operationId": "base-delete", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "boolean" - }, - "examples": { - "Example 1": { - "value": true - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Base"], - "description": "Delete the base details of a given project", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "patch": { - "summary": "Update Base", - "operationId": "base-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {} - }, - "examples": { - "Example 1": { - "value": { - "id": "ds_rrplkgy0pq1f3c", - "project_id": "p_63b4q0qengen1x", - "alias": "sakila", - "meta": null, - "is_meta": null, - "type": "mysql2", - "inflection_column": "camelize", - "inflection_table": "camelize", - "created_at": "2023-03-11T10:31:15.341Z", - "updated_at": "2023-03-11T10:32:25.763Z", - "enabled": true, - "order": 2 - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Base"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "examples": { - "Example 1": { - "value": { - "alias": "sakila", - "type": "mysql2", - "config": { - "client": "mysql2", - "connection": { - "host": "localhost", - "port": "3306", - "user": "root", - "password": "password", - "database": "sakila" - } - }, - "inflection_column": "camelize", - "inflection_table": "camelize" - } - } - } - } - } - }, - "description": "Update the base details of a given project", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/projects/{projectId}/bases/": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - } - ], - "get": { - "summary": "List Bases", - "operationId": "base-list", - "description": "Get project base list", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["Base"], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BaseList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "alias": null, - "config": "", - "enabled": 1, - "id": "ds_krsappzu9f8vmo", - "inflection_column": "camelize", - "inflection_table": "camelize", - "is_meta": 1, - "meta": null, - "order": 1, - "project_id": "p_01clqvzik3izk6", - "type": "mysql2" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - } - }, - "post": { - "summary": "Create Base", - "operationId": "base-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Base" - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/Base" - }, - { - "type": "object", - "properties": { - "external": { - "type": "boolean", - "default": false - } - } - } - ] - }, - "examples": { - "Example 1": { - "value": { - "alias": null, - "config": "", - "enabled": 1, - "id": "ds_krsappzu9f8vmo", - "inflection_column": "camelize", - "inflection_table": "camelize", - "is_meta": 1, - "meta": null, - "order": 1, - "project_id": "p_01clqvzik3izk6", - "type": "mysql2", - "external": false - } - } - } - } - } - }, - "tags": ["Base"], - "description": "Create a new base on a given project", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/projects/{projectId}/shared": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - } - ], - "get": { - "summary": "Get Project Shared Base", - "operationId": "project-shared-base-get", - "description": "Get Project Shared Base", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["Project"], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "uuid": { - "type": "string", - "format": "uuid", - "example": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11" - }, - "url": { - "type": "string", - "format": "uri" - }, - "roles": { - "type": "string", - "example": "viewer" - } - } - }, - "examples": { - "Example 1": { - "value": { - "uuid": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11", - "url": "http://example.com", - "roles": "viewer" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - } - }, - "delete": { - "summary": "Delete Project Shared Base", - "operationId": "project-shared-base-disable", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "boolean" - }, - "examples": { - "Example 1": { - "value": true - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Project"], - "description": "Delete Project Shared Base", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "post": { - "summary": "Create Project Shared Base", - "operationId": "project-shared-base-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "uuid": { - "$ref": "#/components/schemas/StringOrNull" - }, - "roles": { - "$ref": "#/components/schemas/StringOrNull" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Project"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SharedBaseReq" - }, - "examples": { - "Example 1": { - "value": { - "roles": "editor", - "password": "password123" - } - } - } - } - } - }, - "description": "Create Project Shared Base", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "patch": { - "summary": "Update Project Shared Base", - "operationId": "project-shared-base-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "uuid": { - "type": "string", - "format": "uuid", - "example": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11" - }, - "url": { - "type": "string", - "format": "uri" - }, - "roles": { - "type": "string", - "example": "viewer" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SharedBaseReq" - }, - "examples": { - "Example 1": { - "value": { - "password": "password123", - "roles": "editor" - } - } - } - } - } - }, - "tags": ["Project"], - "description": "Update Project Shared Base", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/projects/{projectId}/cost": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - } - ], - "get": { - "summary": "Project Cost", - "operationId": "project-cost", - "description": "Calculate the Project Cost", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["Project"], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {} - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "x-internal": true - } - }, - "/api/v1/db/meta/projects/{projectId}/tables": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - } - ], - "post": { - "summary": "Create Table", - "operationId": "db-table-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Table" - }, - "examples": { - "Example 1": { - "value": { - "base_id": "ds_g4ccx6e77h1dmi", - "columns": [ - { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": "CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP", - "clen": null, - "column_name": "updated_at", - "cop": "4", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "timestamp", - "deleted": null, - "dt": "timestamp", - "dtx": "specificType", - "dtxp": "0", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_m4wkaqgqqjzoeh", - "meta": null, - "np": null, - "ns": null, - "order": 4, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 0, - "system": 0, - "title": "UpdatedAt", - "uidt": "DateTime", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": "CURRENT_TIMESTAMP", - "clen": null, - "column_name": "created_at", - "cop": "3", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "timestamp", - "deleted": null, - "dt": "timestamp", - "dtx": "specificType", - "dtxp": "0", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_jpl0qu4gj4rexq", - "meta": null, - "np": null, - "ns": null, - "order": 3, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 0, - "system": 0, - "title": "CreatedAt", - "uidt": "DateTime", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": null, - "clen": "45", - "column_name": "title", - "cop": "2", - "created_at": "2023-03-02 17:04:06", - "csn": "utf8mb4", - "ct": "varchar(45)", - "deleted": null, - "dt": "varchar", - "dtx": "specificType", - "dtxp": "45", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_c5knoi4xs4sfpt", - "meta": null, - "np": null, - "ns": null, - "order": 2, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": 1, - "rqd": 0, - "system": 0, - "title": "Title", - "uidt": "SingleLineText", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - { - "ai": 1, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": null, - "clen": null, - "column_name": "id", - "cop": "1", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "int unsigned", - "deleted": null, - "dt": "int", - "dtx": "specificType", - "dtxp": "", - "dtxs": "0", - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_phvuuwjrzcdo0g", - "meta": null, - "np": "10", - "ns": "0", - "order": 1, - "pk": 1, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 1, - "system": 0, - "title": "Id", - "uidt": "ID", - "un": 1, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - } - ], - "columnsById": { - "cl_c5knoi4xs4sfpt": { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": null, - "clen": "45", - "column_name": "title", - "cop": "2", - "created_at": "2023-03-02 17:04:06", - "csn": "utf8mb4", - "ct": "varchar(45)", - "deleted": null, - "dt": "varchar", - "dtx": "specificType", - "dtxp": "45", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_c5knoi4xs4sfpt", - "meta": null, - "np": null, - "ns": null, - "order": 2, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": 1, - "rqd": 0, - "system": 0, - "title": "Title", - "uidt": "SingleLineText", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - "cl_jpl0qu4gj4rexq": { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": "CURRENT_TIMESTAMP", - "clen": null, - "column_name": "created_at", - "cop": "3", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "timestamp", - "deleted": null, - "dt": "timestamp", - "dtx": "specificType", - "dtxp": "0", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_jpl0qu4gj4rexq", - "meta": null, - "np": null, - "ns": null, - "order": 3, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 0, - "system": 0, - "title": "CreatedAt", - "uidt": "DateTime", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - "cl_m4wkaqgqqjzoeh": { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": "CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP", - "clen": null, - "column_name": "updated_at", - "cop": "4", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "timestamp", - "deleted": null, - "dt": "timestamp", - "dtx": "specificType", - "dtxp": "0", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_m4wkaqgqqjzoeh", - "meta": null, - "np": null, - "ns": null, - "order": 4, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 0, - "system": 0, - "title": "UpdatedAt", - "uidt": "DateTime", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - "cl_phvuuwjrzcdo0g": { - "ai": 1, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": null, - "clen": null, - "column_name": "id", - "cop": "1", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "int unsigned", - "deleted": null, - "dt": "int", - "dtx": "specificType", - "dtxp": "", - "dtxs": "0", - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_phvuuwjrzcdo0g", - "meta": null, - "np": "10", - "ns": "0", - "order": 1, - "pk": 1, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 1, - "system": 0, - "title": "Id", - "uidt": "ID", - "un": 1, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - } - }, - "created_at": "2023-03-02 17:04:06", - "deleted": null, - "enabled": 1, - "id": "md_rsu68aqjsbyqtl", - "meta": null, - "mm": 0, - "order": 1, - "pinned": null, - "project_id": "p_xm3thidrblw4n7", - "schema": null, - "table_name": "nc_vm5q___Table1", - "tags": null, - "title": "Table1", - "type": "table", - "updated_at": "2023-03-02 17:04:08", - "views": [ - { - "_ptn": "Table1", - "_tn": "Table1", - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:04:06", - "disabled": { - "commenter": false, - "creator": false, - "editor": false, - "guest": false, - "owner": false, - "viewer": false - }, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "vw_p2jcatxz4mvcfw", - "is_default": 1, - "lock_type": "collaborative", - "meta": {}, - "order": 1, - "password": null, - "project_id": "p_xm3thidrblw4n7", - "ptn": "nc_vm5q___Table1", - "ptype": "table", - "show": 1, - "show_system_fields": null, - "table_meta": null, - "title": "Table1", - "tn": "Table1", - "type": 3, - "updated_at": "2023-03-02 17:04:06", - "uuid": null, - "view": { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:04:06", - "fk_view_id": "vw_p2jcatxz4mvcfw", - "meta": null, - "project_id": "p_xm3thidrblw4n7", - "row_height": null, - "updated_at": "2023-03-02 17:04:06", - "uuid": null - } - } - ] - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TableReq" - } - } - } - }, - "tags": ["DB Table"], - "description": "Create a new table in a given project", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "get": { - "summary": "List Tables", - "operationId": "db-table-list", - "responses": { - "200": { - "$ref": "#/components/responses/TableList" - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - }, - { - "schema": { - "type": "number" - }, - "in": "query", - "name": "page" - }, - { - "schema": { - "type": "number" - }, - "in": "query", - "name": "pageSize" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "sort" - }, - { - "schema": { - "type": "boolean" - }, - "in": "query", - "name": "includeM2M" - } - ], - "tags": ["DB Table"], - "description": "List all tables in a given project" - } - }, - "/api/v1/db/meta/tables/{tableId}": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "md_w9gpnaousnfss1", - "type": "string" - }, - "name": "tableId", - "in": "path", - "required": true, - "description": "Unique Table ID" - } - ], - "get": { - "summary": "Read Table", - "operationId": "db-table-read", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Table" - }, - "examples": { - "Example 1": { - "value": { - "id": "md_rsu68aqjsbyqtl", - "base_id": "ds_g4ccx6e77h1dmi", - "project_id": "p_xm3thidrblw4n7", - "table_name": "nc_vm5q___Table1", - "title": "Table1", - "type": "table", - "meta": null, - "schema": null, - "enabled": 1, - "mm": 0, - "tags": null, - "pinned": null, - "deleted": null, - "order": 1, - "created_at": "2023-03-02 17:04:06", - "updated_at": "2023-03-02 17:04:08", - "columns": [ - { - "id": "cl_phvuuwjrzcdo0g", - "base_id": "ds_g4ccx6e77h1dmi", - "project_id": "p_xm3thidrblw4n7", - "fk_model_id": "md_rsu68aqjsbyqtl", - "title": "Id", - "column_name": "id", - "uidt": "ID", - "dt": "int", - "np": "10", - "ns": "0", - "clen": null, - "cop": "1", - "pk": 1, - "pv": null, - "rqd": 1, - "un": 1, - "ct": "int unsigned", - "ai": 1, - "unique": 0, - "cdf": null, - "cc": "", - "csn": null, - "dtx": "specificType", - "dtxp": "", - "dtxs": "0", - "au": 0, - "validate": null, - "virtual": null, - "deleted": null, - "system": 0, - "order": 1, - "created_at": "2023-03-02 17:04:06", - "updated_at": "2023-03-02 17:04:06", - "meta": null - }, - { - "id": "cl_c5knoi4xs4sfpt", - "base_id": "ds_g4ccx6e77h1dmi", - "project_id": "p_xm3thidrblw4n7", - "fk_model_id": "md_rsu68aqjsbyqtl", - "title": "Title", - "column_name": "title", - "uidt": "SingleLineText", - "dt": "varchar", - "np": null, - "ns": null, - "clen": "45", - "cop": "2", - "pk": 0, - "pv": 1, - "rqd": 0, - "un": 0, - "ct": "varchar(45)", - "ai": 0, - "unique": 0, - "cdf": null, - "cc": "", - "csn": "utf8mb4", - "dtx": "specificType", - "dtxp": "45", - "dtxs": null, - "au": 0, - "validate": null, - "virtual": null, - "deleted": null, - "system": 0, - "order": 2, - "created_at": "2023-03-02 17:04:06", - "updated_at": "2023-03-02 17:04:06", - "meta": null - }, - { - "id": "cl_jpl0qu4gj4rexq", - "base_id": "ds_g4ccx6e77h1dmi", - "project_id": "p_xm3thidrblw4n7", - "fk_model_id": "md_rsu68aqjsbyqtl", - "title": "CreatedAt", - "column_name": "created_at", - "uidt": "DateTime", - "dt": "timestamp", - "np": null, - "ns": null, - "clen": null, - "cop": "3", - "pk": 0, - "pv": null, - "rqd": 0, - "un": 0, - "ct": "timestamp", - "ai": 0, - "unique": 0, - "cdf": "CURRENT_TIMESTAMP", - "cc": "", - "csn": null, - "dtx": "specificType", - "dtxp": "0", - "dtxs": null, - "au": 0, - "validate": null, - "virtual": null, - "deleted": null, - "system": 0, - "order": 3, - "created_at": "2023-03-02 17:04:06", - "updated_at": "2023-03-02 17:04:06", - "meta": null - }, - { - "id": "cl_m4wkaqgqqjzoeh", - "base_id": "ds_g4ccx6e77h1dmi", - "project_id": "p_xm3thidrblw4n7", - "fk_model_id": "md_rsu68aqjsbyqtl", - "title": "UpdatedAt", - "column_name": "updated_at", - "uidt": "DateTime", - "dt": "timestamp", - "np": null, - "ns": null, - "clen": null, - "cop": "4", - "pk": 0, - "pv": null, - "rqd": 0, - "un": 0, - "ct": "timestamp", - "ai": 0, - "unique": 0, - "cdf": "CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP", - "cc": "", - "csn": null, - "dtx": "specificType", - "dtxp": "0", - "dtxs": null, - "au": 0, - "validate": null, - "virtual": null, - "deleted": null, - "system": 0, - "order": 4, - "created_at": "2023-03-02 17:04:06", - "updated_at": "2023-03-02 17:04:06", - "meta": null - } - ], - "views": [ - { - "ptn": "nc_vm5q___Table1", - "_ptn": "Table1", - "ptype": "table", - "tn": "Table1", - "_tn": "Table1", - "table_meta": null, - "id": "vw_p2jcatxz4mvcfw", - "base_id": "ds_g4ccx6e77h1dmi", - "project_id": "p_xm3thidrblw4n7", - "fk_model_id": "md_rsu68aqjsbyqtl", - "title": "Table1", - "type": 3, - "is_default": 1, - "show_system_fields": null, - "lock_type": "collaborative", - "uuid": null, - "password": null, - "show": 1, - "order": 1, - "created_at": "2023-03-02 17:04:06", - "updated_at": "2023-03-02 17:04:06", - "meta": {}, - "view": { - "fk_view_id": "vw_p2jcatxz4mvcfw", - "base_id": "ds_g4ccx6e77h1dmi", - "project_id": "p_xm3thidrblw4n7", - "uuid": null, - "created_at": "2023-03-02 17:04:06", - "updated_at": "2023-03-02 17:04:06", - "meta": null, - "row_height": null - }, - "disabled": { - "owner": false, - "creator": false, - "viewer": false, - "editor": false, - "commenter": false, - "guest": false - } - } - ], - "columnsById": { - "cl_phvuuwjrzcdo0g": { - "id": "cl_phvuuwjrzcdo0g", - "base_id": "ds_g4ccx6e77h1dmi", - "project_id": "p_xm3thidrblw4n7", - "fk_model_id": "md_rsu68aqjsbyqtl", - "title": "Id", - "column_name": "id", - "uidt": "ID", - "dt": "int", - "np": "10", - "ns": "0", - "clen": null, - "cop": "1", - "pk": 1, - "pv": null, - "rqd": 1, - "un": 1, - "ct": "int unsigned", - "ai": 1, - "unique": 0, - "cdf": null, - "cc": "", - "csn": null, - "dtx": "specificType", - "dtxp": "", - "dtxs": "0", - "au": 0, - "validate": null, - "virtual": null, - "deleted": null, - "system": 0, - "order": 1, - "created_at": "2023-03-02 17:04:06", - "updated_at": "2023-03-02 17:04:06", - "meta": null - }, - "cl_c5knoi4xs4sfpt": { - "id": "cl_c5knoi4xs4sfpt", - "base_id": "ds_g4ccx6e77h1dmi", - "project_id": "p_xm3thidrblw4n7", - "fk_model_id": "md_rsu68aqjsbyqtl", - "title": "Title", - "column_name": "title", - "uidt": "SingleLineText", - "dt": "varchar", - "np": null, - "ns": null, - "clen": "45", - "cop": "2", - "pk": 0, - "pv": 1, - "rqd": 0, - "un": 0, - "ct": "varchar(45)", - "ai": 0, - "unique": 0, - "cdf": null, - "cc": "", - "csn": "utf8mb4", - "dtx": "specificType", - "dtxp": "45", - "dtxs": null, - "au": 0, - "validate": null, - "virtual": null, - "deleted": null, - "system": 0, - "order": 2, - "created_at": "2023-03-02 17:04:06", - "updated_at": "2023-03-02 17:04:06", - "meta": null - }, - "cl_jpl0qu4gj4rexq": { - "id": "cl_jpl0qu4gj4rexq", - "base_id": "ds_g4ccx6e77h1dmi", - "project_id": "p_xm3thidrblw4n7", - "fk_model_id": "md_rsu68aqjsbyqtl", - "title": "CreatedAt", - "column_name": "created_at", - "uidt": "DateTime", - "dt": "timestamp", - "np": null, - "ns": null, - "clen": null, - "cop": "3", - "pk": 0, - "pv": null, - "rqd": 0, - "un": 0, - "ct": "timestamp", - "ai": 0, - "unique": 0, - "cdf": "CURRENT_TIMESTAMP", - "cc": "", - "csn": null, - "dtx": "specificType", - "dtxp": "0", - "dtxs": null, - "au": 0, - "validate": null, - "virtual": null, - "deleted": null, - "system": 0, - "order": 3, - "created_at": "2023-03-02 17:04:06", - "updated_at": "2023-03-02 17:04:06", - "meta": null - }, - "cl_m4wkaqgqqjzoeh": { - "id": "cl_m4wkaqgqqjzoeh", - "base_id": "ds_g4ccx6e77h1dmi", - "project_id": "p_xm3thidrblw4n7", - "fk_model_id": "md_rsu68aqjsbyqtl", - "title": "UpdatedAt", - "column_name": "updated_at", - "uidt": "DateTime", - "dt": "timestamp", - "np": null, - "ns": null, - "clen": null, - "cop": "4", - "pk": 0, - "pv": null, - "rqd": 0, - "un": 0, - "ct": "timestamp", - "ai": 0, - "unique": 0, - "cdf": "CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP", - "cc": "", - "csn": null, - "dtx": "specificType", - "dtxp": "0", - "dtxs": null, - "au": 0, - "validate": null, - "virtual": null, - "deleted": null, - "system": 0, - "order": 4, - "created_at": "2023-03-02 17:04:06", - "updated_at": "2023-03-02 17:04:06", - "meta": null - } - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table"], - "description": "Read the table meta data by the given table ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "patch": { - "summary": "Update Table", - "operationId": "db-table-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "5a0g9yvs4e678" - }, - "example": "The table has been updated successfully" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "The table has been updated successfully" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "table_name": { - "type": "string", - "description": "Table name", - "example": "users" - }, - "title": { - "type": "string", - "description": "Table title", - "example": "Users" - }, - "project_id": { - "type": "string", - "description": "Project ID", - "example": "p_124hhlkbeasewh" - }, - "meta": { - "$ref": "#/components/schemas/Meta" - } - } - }, - "examples": { - "Example 1": { - "value": { - "table_name": "users", - "title": "Users", - "project_id": "p_124hhlkbeasewh", - "meta": null - } - } - } - } - } - }, - "description": "Update the table meta data by the given table ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "delete": { - "summary": "Delete Table", - "operationId": "db-table-delete", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "boolean" - }, - "examples": { - "Example 1": { - "value": true - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table"], - "description": "Delete the table meta data by the given table ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/projects/{projectId}/{baseId}/tables": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - }, - { - "schema": { - "type": "string", - "pattern": "ds_j04jmxh5xg10lu" - }, - "name": "baseId", - "in": "path", - "required": true, - "description": "Unique Base ID" - } - ], - "get": { - "summary": "List Tables", - "operationId": "table-list", - "responses": { - "200": { - "$ref": "#/components/responses/TableList" - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - }, - { - "schema": { - "type": "number" - }, - "in": "query", - "name": "page" - }, - { - "schema": { - "type": "number" - }, - "in": "query", - "name": "pageSize" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "sort" - }, - { - "schema": { - "type": "boolean" - }, - "in": "query", - "name": "includeM2M" - } - ], - "tags": ["Base"], - "description": "List all tables in a given Project and Base" - }, - "post": { - "summary": "Create Table", - "operationId": "table-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Table" - }, - "examples": { - "Example 1": { - "value": { - "base_id": "ds_g4ccx6e77h1dmi", - "columns": [ - { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": "CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP", - "clen": null, - "column_name": "updated_at", - "cop": "4", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "timestamp", - "deleted": null, - "dt": "timestamp", - "dtx": "specificType", - "dtxp": "0", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_m4wkaqgqqjzoeh", - "meta": null, - "np": null, - "ns": null, - "order": 4, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 0, - "system": 0, - "title": "UpdatedAt", - "uidt": "DateTime", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": "CURRENT_TIMESTAMP", - "clen": null, - "column_name": "created_at", - "cop": "3", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "timestamp", - "deleted": null, - "dt": "timestamp", - "dtx": "specificType", - "dtxp": "0", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_jpl0qu4gj4rexq", - "meta": null, - "np": null, - "ns": null, - "order": 3, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 0, - "system": 0, - "title": "CreatedAt", - "uidt": "DateTime", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": null, - "clen": "45", - "column_name": "title", - "cop": "2", - "created_at": "2023-03-02 17:04:06", - "csn": "utf8mb4", - "ct": "varchar(45)", - "deleted": null, - "dt": "varchar", - "dtx": "specificType", - "dtxp": "45", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_c5knoi4xs4sfpt", - "meta": null, - "np": null, - "ns": null, - "order": 2, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": 1, - "rqd": 0, - "system": 0, - "title": "Title", - "uidt": "SingleLineText", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - { - "ai": 1, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": null, - "clen": null, - "column_name": "id", - "cop": "1", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "int unsigned", - "deleted": null, - "dt": "int", - "dtx": "specificType", - "dtxp": "", - "dtxs": "0", - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_phvuuwjrzcdo0g", - "meta": null, - "np": "10", - "ns": "0", - "order": 1, - "pk": 1, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 1, - "system": 0, - "title": "Id", - "uidt": "ID", - "un": 1, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - } - ], - "columnsById": { - "cl_c5knoi4xs4sfpt": { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": null, - "clen": "45", - "column_name": "title", - "cop": "2", - "created_at": "2023-03-02 17:04:06", - "csn": "utf8mb4", - "ct": "varchar(45)", - "deleted": null, - "dt": "varchar", - "dtx": "specificType", - "dtxp": "45", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_c5knoi4xs4sfpt", - "meta": null, - "np": null, - "ns": null, - "order": 2, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": 1, - "rqd": 0, - "system": 0, - "title": "Title", - "uidt": "SingleLineText", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - "cl_jpl0qu4gj4rexq": { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": "CURRENT_TIMESTAMP", - "clen": null, - "column_name": "created_at", - "cop": "3", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "timestamp", - "deleted": null, - "dt": "timestamp", - "dtx": "specificType", - "dtxp": "0", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_jpl0qu4gj4rexq", - "meta": null, - "np": null, - "ns": null, - "order": 3, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 0, - "system": 0, - "title": "CreatedAt", - "uidt": "DateTime", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - "cl_m4wkaqgqqjzoeh": { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": "CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP", - "clen": null, - "column_name": "updated_at", - "cop": "4", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "timestamp", - "deleted": null, - "dt": "timestamp", - "dtx": "specificType", - "dtxp": "0", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_m4wkaqgqqjzoeh", - "meta": null, - "np": null, - "ns": null, - "order": 4, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 0, - "system": 0, - "title": "UpdatedAt", - "uidt": "DateTime", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - "cl_phvuuwjrzcdo0g": { - "ai": 1, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": null, - "clen": null, - "column_name": "id", - "cop": "1", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "int unsigned", - "deleted": null, - "dt": "int", - "dtx": "specificType", - "dtxp": "", - "dtxs": "0", - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_phvuuwjrzcdo0g", - "meta": null, - "np": "10", - "ns": "0", - "order": 1, - "pk": 1, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 1, - "system": 0, - "title": "Id", - "uidt": "ID", - "un": 1, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - } - }, - "created_at": "2023-03-02 17:04:06", - "deleted": null, - "enabled": 1, - "id": "md_rsu68aqjsbyqtl", - "meta": null, - "mm": 0, - "order": 1, - "pinned": null, - "project_id": "p_xm3thidrblw4n7", - "schema": null, - "table_name": "nc_vm5q___Table1", - "tags": null, - "title": "Table1", - "type": "table", - "updated_at": "2023-03-02 17:04:08", - "views": [ - { - "_ptn": "Table1", - "_tn": "Table1", - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:04:06", - "disabled": { - "commenter": false, - "creator": false, - "editor": false, - "guest": false, - "owner": false, - "viewer": false - }, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "vw_p2jcatxz4mvcfw", - "is_default": 1, - "lock_type": "collaborative", - "meta": {}, - "order": 1, - "password": null, - "project_id": "p_xm3thidrblw4n7", - "ptn": "nc_vm5q___Table1", - "ptype": "table", - "show": 1, - "show_system_fields": null, - "table_meta": null, - "title": "Table1", - "tn": "Table1", - "type": 3, - "updated_at": "2023-03-02 17:04:06", - "uuid": null, - "view": { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:04:06", - "fk_view_id": "vw_p2jcatxz4mvcfw", - "meta": null, - "project_id": "p_xm3thidrblw4n7", - "row_height": null, - "updated_at": "2023-03-02 17:04:06", - "uuid": null - } - } - ] - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TableReq" - }, - "examples": { - "Example 1": { - "value": { - "columns": [ - { - "ai": false, - "altered": 1, - "cdf": "CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP", - "ck": false, - "clen": 45, - "column_name": "updated_at", - "ct": "varchar(45)", - "dt": "timestamp", - "dtx": "specificType", - "dtxp": "", - "dtxs": "", - "np": null, - "nrqd": true, - "ns": null, - "pk": false, - "rqd": false, - "title": "UpdatedAt", - "uicn": "", - "uidt": "DateTime", - "uip": "", - "un": false - }, - { - "ai": false, - "altered": 1, - "cdf": "CURRENT_TIMESTAMP", - "ck": false, - "clen": 45, - "column_name": "created_at", - "ct": "varchar(45)", - "dt": "timestamp", - "dtx": "specificType", - "dtxp": "", - "dtxs": "", - "np": null, - "nrqd": true, - "ns": null, - "pk": false, - "rqd": false, - "title": "CreatedAt", - "uicn": "", - "uidt": "DateTime", - "uip": "", - "un": false - }, - { - "ai": false, - "altered": 1, - "cdf": null, - "ck": false, - "clen": 45, - "column_name": "title", - "ct": "varchar(45)", - "dt": "varchar", - "dtx": "specificType", - "dtxp": "45", - "dtxs": "", - "np": null, - "nrqd": true, - "ns": null, - "pk": false, - "rqd": false, - "title": "Title", - "uicn": "", - "uidt": "SingleLineText", - "uip": "", - "un": false - }, - { - "ai": true, - "altered": 1, - "cdf": null, - "ck": false, - "clen": null, - "column_name": "id", - "ct": "int(11)", - "dt": "int", - "dtx": "integer", - "dtxp": "11", - "dtxs": "", - "np": 11, - "nrqd": false, - "ns": 0, - "pk": true, - "rqd": true, - "title": "Id", - "uicn": "", - "uidt": "ID", - "uip": "", - "un": true - } - ], - "table_name": "Sheet-1", - "title": "Sheet-1" - } - } - } - } - } - }, - "tags": ["Base"], - "description": "Create a new table in a given Project and Base", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/tables/{tableId}/reorder": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "md_w9gpnaousnfss1", - "type": "string" - }, - "name": "tableId", - "in": "path", - "required": true, - "description": "Unique Table ID" - } - ], - "post": { - "summary": "Reorder Table", - "operationId": "db-table-reorder", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "boolean" - }, - "examples": { - "Example 1": { - "value": true - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "order": { - "type": "number" - } - } - }, - "examples": { - "Example 1": { - "value": { - "order": 0 - } - } - } - } - } - }, - "tags": ["DB Table"], - "description": "Update the order of the given Table", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/tables/{tableId}/columns": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "md_w9gpnaousnfss1", - "type": "string" - }, - "name": "tableId", - "in": "path", - "required": true, - "description": "Unique Table ID" - } - ], - "post": { - "summary": "Create Column", - "operationId": "db-table-column-create", - "responses": { - "200": { - "description": "OK" - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ColumnReq" - }, - "examples": { - "Example 1": { - "value": { - "ai": 0, - "au": 0, - "base_id": "ds_krsappzu9f8vmo", - "cc": "", - "cdf": null, - "clen": "45", - "column_name": "title", - "cop": "2", - "csn": "utf8mb4", - "ct": "varchar(45)", - "deleted": null, - "dt": "varchar", - "dtx": "specificType", - "dtxp": "45", - "dtxs": null, - "fk_model_id": "md_yvwvbt2i78rgcm", - "id": "cl_0j9gv0oi8vjy46", - "meta": null, - "np": null, - "ns": null, - "order": 2, - "pk": 0, - "project_id": "p_01clqvzik3izk6", - "pv": 1, - "rqd": 0, - "system": 0, - "title": "Title", - "uidt": "SingleLineText", - "un": 0, - "unique": 0, - "validate": null, - "virtual": null - } - } - } - } - } - }, - "tags": ["DB Table Column"], - "description": "Create a new column in a given Table", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/columns/{columnId}": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "columnId", - "in": "path", - "required": true - } - ], - "patch": { - "summary": "Update Column", - "operationId": "db-table-column-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Column" - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ColumnReq" - } - } - } - }, - "tags": ["DB Table Column"], - "description": "Update the existing column by the given column ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "delete": { - "summary": "Delete Column", - "operationId": "db-table-column-delete", - "responses": { - "200": { - "description": "OK" - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Column"], - "description": "Delete the existing column by the given column ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "get": { - "summary": "Get Column", - "operationId": "db-table-column-get", - "responses": { - "200": { - "description": "OK" - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Column"], - "description": "Get the existing column by the given column ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/columns/{columnId}/primary": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "columnId", - "in": "path", - "required": true - } - ], - "post": { - "summary": "Create Primary Value", - "operationId": "db-table-column-primary-column-set", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "boolean" - }, - "examples": { - "Example 1": { - "value": true - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Column"], - "description": "Set a primary value on a given column", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/tables/{tableId}/views": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "md_w9gpnaousnfss1", - "type": "string" - }, - "name": "tableId", - "in": "path", - "required": true, - "description": "Unique Table ID" - } - ], - "get": { - "summary": "List Views", - "operationId": "db-view-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ViewList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "alias": "string", - "column": [ - { - "alias": "string", - "auto_increment": true, - "auto_update_timestamp": true, - "base_id": "string", - "character_maximum_length": "string", - "character_set_name": "string", - "colOptions": { - "deleted": "string", - "dr": "string", - "fk_child_column_id": "string", - "fk_column_id": "string", - "fk_index_name": "string", - "fk_mm_child_column_id": "string", - "fk_mm_model_id": "string", - "fk_mm_parent_column_id": "string", - "fk_parent_column_id": "string", - "id": "string", - "order": "string", - "type": "string", - "ur": "string", - "virtual": true - }, - "column_comment": "string", - "column_default": "string", - "column_ordinal_position": "string", - "column_type": "string", - "data_type": "string", - "data_type_x": "string", - "data_type_x_precision": "string", - "data_type_x_scale": "string", - "deleted": true, - "fk_model_id": "string", - "id": "string", - "numeric_precision": "string", - "numeric_scale": "string", - "order": 0, - "primary_key": true, - "primary_value": true, - "rqd": "string", - "title": "string", - "ui_data_type": "string", - "un": "string", - "unique": true, - "visible": true - } - ], - "columnByIds": {}, - "deleted": true, - "enabled": true, - "fk_base_id": "string", - "fk_project_id": "string", - "id": "string", - "order": 0, - "parent_id": "string", - "pinned": true, - "show_as": "string", - "tags": "string", - "title": "string", - "type": "string" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "description": "List all views in a given Table.", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/views/{viewId}": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "vw_wtdg2meyig5l4q" - }, - "name": "viewId", - "in": "path", - "required": true, - "description": "Unique View ID" - } - ], - "patch": { - "summary": "Update View", - "operationId": "db-view-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/View" - }, - "examples": { - "Example 1": { - "value": { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:46:31", - "fk_model_id": "md_mhs9z4r2ak98x0", - "id": "vw_lg052cnc1c26kf", - "is_default": 1, - "lock_type": "collaborative", - "meta": "{\"allowCSVDownload\":true}", - "order": 1, - "password": "password123", - "project_id": "p_xm3thidrblw4n7", - "show": 1, - "show_system_fields": null, - "title": "Grid View 1", - "type": 3, - "updated_at": "2023-03-02 17:46:31", - "uuid": null - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ViewUpdateReq" - }, - "examples": { - "Example 1": { - "value": { - "title": "Grid View 1", - "uuid": "e2457bbf-e29c-4fec-866e-fe3b01dba57f", - "password": "password123", - "lock_type": "collaborative", - "meta": "{\"allowCSVDownload\":true}", - "order": 1, - "show_system_fields": 0 - } - } - } - } - } - }, - "tags": ["DB View"], - "description": "Update the view with the given view Id.", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "delete": { - "summary": "Delete View", - "operationId": "db-view-delete", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "boolean" - }, - "examples": { - "Example 1": { - "value": true - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "description": "Delete the view with the given view Id.", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/views/{viewId}/show-all": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "vw_wtdg2meyig5l4q" - }, - "name": "viewId", - "in": "path", - "required": true, - "description": "Unique View ID" - } - ], - "post": { - "summary": "Show All Columns In View", - "operationId": "db-view-show-all-column", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "boolean" - }, - "examples": { - "Example 1": { - "value": true - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "description": "Show All Columns in a given View", - "parameters": [ - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "ignoreIds" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/views/{viewId}/hide-all": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "vw_wtdg2meyig5l4q" - }, - "name": "viewId", - "in": "path", - "required": true, - "description": "Unique View ID" - } - ], - "post": { - "summary": "Hide All Columns In View", - "operationId": "db-view-hide-all-column", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "boolean" - }, - "examples": { - "Example 1": { - "value": true - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "parameters": [ - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "ignoreIds" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "description": "Hide All Columns in a given View" - } - }, - "/api/v1/db/meta/tables/{tableId}/share": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "md_w9gpnaousnfss1", - "type": "string" - }, - "name": "tableId", - "in": "path", - "required": true, - "description": "Unique Table ID" - } - ], - "get": { - "summary": "List Shared Views", - "operationId": "db-view-share-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SharedViewList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:46:31", - "fk_model_id": "md_mhs9z4r2ak98x0", - "id": "vw_lg052cnc1c26kf", - "is_default": 1, - "lock_type": "collaborative", - "meta": {}, - "order": 1, - "project_id": "p_xm3thidrblw4n7", - "show": 1, - "show_system_fields": null, - "title": "Sheet-1", - "type": 3, - "updated_at": "2023-03-02 17:46:31", - "uuid": null, - "view": { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:46:31", - "fk_view_id": "vw_lg052cnc1c26kf", - "meta": null, - "project_id": "p_xm3thidrblw4n7", - "row_height": null, - "updated_at": "2023-03-02 17:46:31", - "uuid": null - } - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "List all shared views in a given Table", - "tags": ["DB View Share"], - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/views/{viewId}/share": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "vw_wtdg2meyig5l4q" - }, - "name": "viewId", - "in": "path", - "required": true, - "description": "Unique View ID" - } - ], - "post": { - "summary": "Create Shared View", - "operationId": "db-view-share-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SharedViewReq" - }, - "examples": { - "Example 1": { - "value": { - "meta": {}, - "password": "123456789" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View Share"], - "description": "Create a shared view in a given View..", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "patch": { - "summary": "Update Shared View", - "operationId": "db-view-share-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SharedView" - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SharedViewReq" - } - } - }, - "description": "" - }, - "tags": ["DB View Share"], - "description": "Update a shared view in a given View..", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "delete": { - "summary": "Delete Shared View", - "operationId": "db-view-share-delete", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "boolean" - }, - "examples": { - "Example 1": { - "value": true - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Delete a shared view in a given View.", - "tags": ["DB View Share"], - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/views/{viewId}/columns": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "vw_wtdg2meyig5l4q" - }, - "name": "viewId", - "in": "path", - "required": true, - "description": "Unique View ID" - } - ], - "get": { - "summary": "List Columns In View", - "operationId": "db-view-column-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ColumnList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "ai": 0, - "au": 0, - "base_id": "ds_krsappzu9f8vmo", - "cc": "", - "cdf": null, - "clen": "45", - "column_name": "title", - "cop": "2", - "created_at": "2023-03-02 13:14:16", - "csn": "utf8mb4", - "ct": "varchar(45)", - "deleted": null, - "dt": "varchar", - "dtx": "specificType", - "dtxp": "45", - "dtxs": null, - "fk_model_id": "md_yvwvbt2i78rgcm", - "id": "cl_0j9gv0oi8vjy46", - "meta": null, - "np": null, - "ns": null, - "order": 2, - "pk": 0, - "project_id": "p_01clqvzik3izk6", - "pv": 1, - "rqd": 0, - "system": 0, - "title": "Title", - "uidt": "SingleLineText", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 13:14:16", - "validate": null, - "virtual": null - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View Column"], - "description": "List all columns by ViewID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "post": { - "summary": "Create Column in View", - "operationId": "db-view-column-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Column" - }, - "examples": { - "Example 1": { - "value": { - "ai": 0, - "au": 0, - "base_id": "ds_krsappzu9f8vmo", - "cc": "", - "cdf": null, - "clen": "45", - "column_name": "title", - "cop": "2", - "created_at": "2023-03-02 13:14:16", - "csn": "utf8mb4", - "ct": "varchar(45)", - "deleted": null, - "dt": "varchar", - "dtx": "specificType", - "dtxp": "45", - "dtxs": null, - "fk_model_id": "md_yvwvbt2i78rgcm", - "id": "cl_0j9gv0oi8vjy46", - "meta": null, - "np": null, - "ns": null, - "order": 2, - "pk": 0, - "project_id": "p_01clqvzik3izk6", - "pv": 1, - "rqd": 0, - "system": 0, - "title": "Title", - "uidt": "SingleLineText", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 13:14:16", - "validate": null, - "virtual": null - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View Column"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ViewColumnReq" - }, - "examples": { - "Example 1": { - "value": { - "fk_column_id": "cl_m4wkaqgqqjzoeh", - "show": 0, - "order": 1 - } - } - } - } - } - }, - "description": "Create a new column in a given View", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/views/{viewId}/columns/{columnId}": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "vw_wtdg2meyig5l4q" - }, - "name": "viewId", - "in": "path", - "required": true - }, - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "cl_8iw2o4ejzvdyna", - "type": "string" - }, - "name": "columnId", - "in": "path", - "required": true, - "description": "Unique Column ID" - } - ], - "patch": { - "summary": "Update View Column", - "operationId": "db-view-column-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number" - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View Column"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ViewColumnUpdateReq" - }, - "examples": { - "Example 1": { - "value": { - "show": 0, - "order": 1 - } - } - } - } - } - }, - "description": "Update a column in a View", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/views/{viewId}/sorts": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "vw_wtdg2meyig5l4q" - }, - "name": "viewId", - "in": "path", - "required": true, - "description": "Unique View ID" - } - ], - "get": { - "summary": "List View Sorts", - "operationId": "db-table-sort-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SortList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "id": "so_xd4t51uv60ghzl", - "fk_column_id": "cl_l11b769pe2j1ce", - "fk_model_id": "md_ehn5izr99m7d45", - "base_id": "ds_3l9qx8xqksenrl", - "direction": "desc", - "order": 1, - "project_id": "p_9sx43moxhqtjm3" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Sort"], - "description": "List all the sort data in a given View", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "post": { - "summary": "Update View Sort", - "operationId": "db-table-sort-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number" - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Sort"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/SortReq" - }, - { - "type": "object", - "properties": { - "push_to_top": { - "type": "boolean", - "example": true, - "description": "Push the sort to the top of the list" - } - } - } - ] - } - } - } - }, - "description": "Update the sort data in a given View", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/sorts/{sortId}": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "so_xd4t51uv60ghzl" - }, - "name": "sortId", - "in": "path", - "description": "Unique Sort ID", - "required": true - } - ], - "get": { - "summary": "Get Sort", - "operationId": "db-table-sort-get", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Sort" - }, - "examples": { - "Example 1": { - "value": { - "id": "so_xd4t51uv60ghzl", - "fk_column_id": "cl_l11b769pe2j1ce", - "fk_model_id": "md_ehn5izr99m7d45", - "base_id": "ds_3l9qx8xqksenrl", - "direction": "desc", - "order": 1, - "project_id": "p_9sx43moxhqtjm3" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Sort"], - "description": "Get the sort data by Sort ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "patch": { - "summary": "Update Sort", - "operationId": "db-table-sort-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number", - "example": 1 - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Sort"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SortReq" - }, - "examples": { - "Example 1": { - "value": { - "direction": "asc", - "fk_column_id": "cl_l11b769pe2j1ce" - } - } - } - } - } - }, - "description": "Update the sort data by Sort ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "delete": { - "summary": "Delete Sort", - "operationId": "db-table-sort-delete", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "boolean" - }, - "examples": { - "Example 1": { - "value": true - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Sort"], - "description": "Delete the sort data by Sort ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/views/{viewId}/filters": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "vw_wtdg2meyig5l4q" - }, - "name": "viewId", - "in": "path", - "required": true, - "description": "Unique View ID" - } - ], - "get": { - "summary": "Get View Filter", - "operationId": "db-table-filter-read", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FilterList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "comparison_op": "eq", - "comparison_sub_op": null, - "created_at": "2023-03-02 18:18:05", - "fk_column_id": "cl_d7ah9n2qfupgys", - "fk_hook_id": null, - "fk_parent_id": null, - "fk_view_id": "vw_b739e29vqmrxnf", - "id": "fi_xn647tpmdq8fu8", - "is_group": null, - "logical_op": "and", - "order": 1, - "project_id": "p_xm3thidrblw4n7", - "updated_at": "2023-03-02 18:18:05", - "value": "foo" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Filter"], - "description": "Get the filter data in a given View", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "post": { - "summary": "Create View Filter", - "operationId": "db-table-filter-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Filter" - }, - "examples": { - "Example 1": { - "value": { - "base_id": "ds_g4ccx6e77h1dmi", - "comparison_op": "eq", - "comparison_sub_op": null, - "created_at": "2023-03-02 18:18:05", - "fk_column_id": "cl_d7ah9n2qfupgys", - "fk_hook_id": null, - "fk_parent_id": null, - "fk_view_id": "vw_b739e29vqmrxnf", - "id": "fi_xn647tpmdq8fu8", - "is_group": null, - "logical_op": "and", - "order": 1, - "project_id": "p_xm3thidrblw4n7", - "updated_at": "2023-03-02 18:18:05", - "value": "foo" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Filter"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FilterReq" - }, - "examples": { - "Example 1": { - "value": { - "comparison_op": "eq", - "comparison_sub_op": null, - "fk_column_id": "cl_d7ah9n2qfupgys", - "is_group": false, - "logical_op": "and", - "value": "foo" - } - } - } - } - } - }, - "description": "Update the filter data in a given View", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/hooks/{hookId}/filters": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "hk_0063k4o1frnxbr" - }, - "name": "hookId", - "in": "path", - "required": true, - "description": "Unique Hook ID" - } - ], - "get": { - "summary": "Get Hook Filter", - "operationId": "db-table-webhook-filter-read", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FilterList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "comparison_op": "eq", - "comparison_sub_op": null, - "created_at": "2023-03-02 18:18:05", - "fk_column_id": "cl_d7ah9n2qfupgys", - "fk_hook_id": null, - "fk_parent_id": null, - "fk_view_id": "vw_b739e29vqmrxnf", - "id": "fi_xn647tpmdq8fu8", - "is_group": null, - "logical_op": "and", - "order": 1, - "project_id": "p_xm3thidrblw4n7", - "updated_at": "2023-03-02 18:18:05", - "value": "foo" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Webhook Filter"], - "description": "Get the filter data in a given Hook", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "post": { - "summary": "Create Hook Filter", - "operationId": "db-table-webhook-filter-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Filter" - }, - "examples": { - "Example 1": { - "value": { - "base_id": "ds_g4ccx6e77h1dmi", - "comparison_op": "eq", - "comparison_sub_op": null, - "created_at": "2023-03-02 18:18:05", - "fk_column_id": "cl_d7ah9n2qfupgys", - "fk_hook_id": null, - "fk_parent_id": null, - "fk_view_id": "vw_b739e29vqmrxnf", - "id": "fi_xn647tpmdq8fu8", - "is_group": null, - "logical_op": "and", - "order": 1, - "project_id": "p_xm3thidrblw4n7", - "updated_at": "2023-03-02 18:18:05", - "value": "foo" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Webhook Filter"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FilterReq" - }, - "examples": { - "Example 1": { - "value": { - "comparison_op": "eq", - "comparison_sub_op": null, - "fk_column_id": "cl_d7ah9n2qfupgys", - "is_group": false, - "logical_op": "and", - "value": "foo" - } - } - } - } - } - }, - "description": "Create filter(s) in a given Hook", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/hooks/{hookId}/logs": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "hk_0063k4o1frnxbr" - }, - "name": "hookId", - "in": "path", - "required": true, - "description": "Unique Hook ID" - } - ], - "get": { - "summary": "List Hook Logs", - "operationId": "db-table-webhook-logs-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HookLogList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "base_id": "ds_jxuewivwbxeum2", - "event": "after", - "execution_time": "98", - "fk_hook_id": "hk_035ijv5qdi97y5", - "id": "string", - "notifications": "{\"type\":\"URL\",\"payload\":{\"method\":\"POST\",\"body\":\"{{ json data }}\",\"headers\":[{}],\"parameters\":[{}],\"auth\":\"\",\"path\":\"https://webhook.site/6eb45ce5-b611-4be1-8b96-c2965755662b\"}}", - "operation": "insert", - "payload": "{\"method\":\"POST\",\"body\":\"{{ json data }}\",\"headers\":[{}],\"parameters\":[{}],\"auth\":\"\",\"path\":\"https://webhook.site/6eb45ce5-b611-4be1-8b96-c2965755662b\"}", - "project_id": "p_tbhl1hnycvhe5l", - "response": "{\"status\":200,\"statusText\":\"OK\",\"headers\":{\"server\":\"nginx\",\"content-type\":\"text/plain; charset=UTF-8\",\"transfer-encoding\":\"chunked\",\"connection\":\"close\",\"vary\":\"Accept-Encoding\",\"x-request-id\":\"53844a7d-ede8-4798-adf7-8af441908a72\",\"x-token-id\":\"6eb45ce5-b611-4be1-8b96-c2965755662b\",\"cache-control\":\"no-cache, private\",\"date\":\"Fri, 24 Mar 2023 10:50:10 GMT\"},\"config\":{\"url\":\"https://webhook.site/6eb45ce5-b611-4be1-8b96-c2965755662b\",\"method\":\"post\",\"data\":\"{\\\"type\\\":\\\"records.after.insert\\\",\\\"id\\\":\\\"a77d97dc-a3e4-4719-9b46-45f93e0cc99a\\\",\\\"data\\\":{\\\"table_id\\\":\\\"md_d8v403o74mf5lf\\\",\\\"table_name\\\":\\\"Sheet-2\\\"}}\",\"headers\":{\"Accept\":\"application/json, text/plain, */*\",\"Content-Type\":\"application/x-www-form-urlencoded\",\"User-Agent\":\"axios/0.21.4\",\"Content-Length\":138},\"params\":{}}}", - "test_call": 0, - "triggered_by": "w@nocodb.com", - "type": "URL" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Webhook Logs"], - "description": "List the log data in a given Hook", - "parameters": [ - { - "schema": { - "type": "integer", - "minimum": 1 - }, - "in": "query", - "name": "limit" - }, - { - "schema": { - "type": "integer", - "minimum": 0 - }, - "in": "query", - "name": "offset" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/filters/{filterId}": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "pattern": "fi_pgfuo11uhn2xeo" - }, - "name": "filterId", - "in": "path", - "required": true, - "description": "Unique Filter ID" - } - ], - "get": { - "summary": "Get Filter", - "operationId": "db-table-filter-get", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Filter" - }, - "examples": { - "Example 1": { - "value": { - "base_id": "ds_g4ccx6e77h1dmi", - "comparison_op": "eq", - "comparison_sub_op": null, - "created_at": "2023-03-02 18:18:05", - "fk_column_id": "cl_d7ah9n2qfupgys", - "fk_hook_id": null, - "fk_parent_id": null, - "fk_view_id": "vw_b739e29vqmrxnf", - "id": "fi_xn647tpmdq8fu8", - "is_group": null, - "logical_op": "and", - "order": 1, - "project_id": "p_xm3thidrblw4n7", - "updated_at": "2023-03-02 18:18:05", - "value": "foo" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Filter"], - "description": "Get the filter data with a given Filter ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "patch": { - "summary": "Update Filter", - "operationId": "db-table-filter-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number" - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Filter"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FilterReq" - }, - "examples": { - "Example 1": { - "value": { - "comparison_op": "eq", - "comparison_sub_op": null, - "fk_column_id": "cl_d7ah9n2qfupgys", - "is_group": false, - "logical_op": "and", - "value": "foo" - } - } - } - } - } - }, - "description": "Update the filter data with a given Filter ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "delete": { - "summary": "Delete Filter", - "operationId": "db-table-filter-delete", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "boolean" - }, - "examples": { - "Example 1": { - "value": true - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Filter"], - "description": "Delete the filter data with a given Filter ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/filters/{filterGroupId}/children": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "fi_pgfuo11uhn2xeo", - "description": "Filter Group ID" - }, - "name": "filterGroupId", - "in": "path", - "required": true - } - ], - "get": { - "summary": "Get Filter Group Children", - "operationId": "db-table-filter-children-read", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FilterList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "comparison_op": "eq", - "comparison_sub_op": null, - "created_at": "2023-03-02 18:18:05", - "fk_column_id": "cl_d7ah9n2qfupgys", - "fk_hook_id": null, - "fk_parent_id": null, - "fk_view_id": "vw_b739e29vqmrxnf", - "id": "fi_xn647tpmdq8fu8", - "is_group": null, - "logical_op": "and", - "order": 1, - "project_id": "p_xm3thidrblw4n7", - "updated_at": "2023-03-02 18:18:05", - "value": "foo" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Filter"], - "description": "Get Filter Group Children of a given group ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/tables/{tableId}/grids": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "md_w9gpnaousnfss1", - "type": "string" - }, - "name": "tableId", - "in": "path", - "required": true, - "description": "Unique Table ID" - } - ], - "post": { - "summary": "Create Grid View", - "operationId": "db-view-grid-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/View" - }, - "examples": { - "Example 1": { - "value": { - "id": "vw_o50jiw9v2txktv", - "base_id": "ds_a95vextjl510z7", - "project_id": "p_slkm6i3v31q4bc", - "fk_model_id": "md_8hr3xndx8umuce", - "title": "Grid-1", - "type": 3, - "is_default": null, - "show_system_fields": null, - "lock_type": "collaborative", - "uuid": null, - "password": null, - "show": true, - "order": 2, - "created_at": "2023-03-13T07:29:16.610Z", - "updated_at": "2023-03-13T07:29:16.610Z", - "meta": {} - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ViewCreateReq" - }, - "examples": { - "Example 1": { - "value": { - "title": "My Grid View", - "type": 3, - "copy_from_id": null, - "fk_grp_col_id": null, - "fk_geo_data_col_id": null - } - } - } - } - } - }, - "description": "Create a new grid view in a given Table", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/tables/{tableId}/forms": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "md_w9gpnaousnfss1", - "type": "string" - }, - "name": "tableId", - "in": "path", - "required": true, - "description": "Unique Table ID" - } - ], - "post": { - "summary": "Create Form View", - "operationId": "db-view-form-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/View" - }, - "examples": { - "Example 1": { - "value": { - "id": "vw_a830n4bmwk8wlp", - "base_id": "ds_a95vextjl510z7", - "project_id": "p_slkm6i3v31q4bc", - "fk_model_id": "md_8hr3xndx8umuce", - "title": "Form-1", - "type": 1, - "is_default": null, - "show_system_fields": null, - "lock_type": "collaborative", - "uuid": null, - "password": null, - "show": true, - "order": 4, - "created_at": "2023-03-13T07:29:19.957Z", - "updated_at": "2023-03-13T07:29:19.957Z", - "meta": {} - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Create a new form view in a given Table", - "tags": ["DB View"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ViewCreateReq" - }, - "examples": { - "Example 1": { - "value": { - "title": "My Form View", - "type": 1, - "copy_from_id": null, - "fk_grp_col_id": null, - "fk_geo_data_col_id": null - } - } - } - } - } - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/forms/{formViewId}": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "vw_6fqln9vdytdv8q" - }, - "name": "formViewId", - "in": "path", - "required": true, - "description": "Unique Form View ID" - } - ], - "patch": { - "summary": "Update Form View", - "operationId": "db-view-form-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number" - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FormUpdateReq" - }, - "examples": { - "Example 1": { - "value": { - "banner_image_url": null, - "email": "user@example.com", - "heading": "My Form", - "lock_type": "collaborative", - "logo_url": null, - "meta": null, - "redirect_after_secs": null, - "redirect_url": null, - "show_blank_form": 0, - "subheading": "My Form Subheading", - "submit_another_form": 0, - "success_msg": "Thank you for the submission.", - "title": "Form View 1" - } - } - } - } - } - }, - "description": "Update the form data by Form ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "get": { - "summary": "Get Form", - "operationId": "db-view-form-read", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Form" - }, - "examples": { - "Example 1": { - "value": { - "base_id": "ds_g4ccx6e77h1dmi", - "banner_image_url": null, - "columns": [ - { - "id": "fvc_ugj9zo5bzocxtl", - "base_id": "ds_g4ccx6e77h1dmi", - "project_id": "p_xm3thidrblw4n7", - "fk_view_id": "vw_kdf5cr7qmhksek", - "fk_column_id": "cl_phvuuwjrzcdo0g", - "uuid": null, - "label": null, - "help": null, - "description": null, - "required": null, - "show": 0, - "order": 1, - "created_at": "2023-03-04 16:40:47", - "updated_at": "2023-03-04 16:40:47", - "meta": {} - } - ], - "email": "user@example.com", - "fk_model_id": "md_rsu68aqjsbyqtl", - "heading": "My Form", - "lock_type": "collaborative", - "logo_url": null, - "meta": null, - "redirect_after_secs": null, - "redirect_url": null, - "show_blank_form": 0, - "subheading": "My Form Subheading", - "submit_another_form": 0, - "success_msg": "Thank you for the submission.", - "title": "Form View 1" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "description": "Get the form data by Form ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/form-columns/{formViewColumnId}": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "fvc_1m9b0aub791d4m", - "type": "string" - }, - "name": "formViewColumnId", - "in": "path", - "required": true, - "description": "Unique Form View Column ID" - } - ], - "patch": { - "summary": "Update Form Column", - "operationId": "db-view-form-column-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FormColumnReq" - }, - "examples": { - "Example 1": { - "value": { - "description": null, - "help": "This is a help text", - "label": "Form Label", - "meta": null, - "order": 1, - "required": 0, - "show": 0 - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FormColumnReq" - } - } - } - }, - "description": "Update the form column(s) by Form View Column ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/grids/{viewId}": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "vw_wtdg2meyig5l4q" - }, - "name": "viewId", - "in": "path", - "required": true, - "description": "Unique View ID" - } - ], - "patch": { - "summary": "Update Grid View", - "operationId": "db-view-grid-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number" - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GridUpdateReq" - }, - "examples": { - "Example 1": { - "value": { - "row_height": 1, - "meta": null - } - } - } - } - } - }, - "description": "Update Grid View", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/grids/{gridId}/grid-columns": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "vw_q6k13mmygdi3yz" - }, - "name": "gridId", - "in": "path", - "required": true, - "description": "Grid View ID" - } - ], - "get": { - "summary": "List Grid Columns", - "operationId": "db-view-grid-columns-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GridColumn" - } - }, - "examples": { - "Example 1": { - "value": [ - { - "id": "nc_c8jz4kxe6xvh11", - "fk_view_id": "vw_p2jcatxz4mvcfw", - "fk_column_id": "cl_c5knoi4xs4sfpt", - "project_id": "p_xm3thidrblw4n7", - "base_id": "ds_g4ccx6e77h1dmi", - "show": 0, - "order": 1, - "width": "200px", - "help": null - } - ] - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "description": "List all columns in the given Grid", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/grid-columns/{columnId}": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "cl_8iw2o4ejzvdyna", - "type": "string" - }, - "name": "columnId", - "in": "path", - "required": true, - "description": "Unique Column ID" - } - ], - "patch": { - "summary": "Update Grid Column", - "operationId": "db-view-grid-column-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number" - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GridColumnReq" - }, - "examples": { - "Example 1": { - "value": { - "fk_column_id": "cl_c5knoi4xs4sfpt", - "label": "My Column", - "width": "200px" - } - } - } - } - } - }, - "description": "Update grid column(s) in the given Grid", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/tables/{tableId}/galleries": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "md_w9gpnaousnfss1" - }, - "name": "tableId", - "in": "path", - "required": true, - "description": "Unique Table ID" - } - ], - "post": { - "summary": "Create Gallery View", - "operationId": "db-view-gallery-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/View" - }, - "examples": { - "Example 1": { - "value": { - "id": "vw_qp94qfnvffgk5f", - "base_id": "ds_a95vextjl510z7", - "project_id": "p_slkm6i3v31q4bc", - "fk_model_id": "md_8hr3xndx8umuce", - "title": "Gallery-1", - "type": 2, - "is_default": null, - "show_system_fields": null, - "lock_type": "collaborative", - "uuid": null, - "password": null, - "show": true, - "order": 3, - "created_at": "2023-03-13T07:29:18.707Z", - "updated_at": "2023-03-13T07:29:18.707Z", - "meta": {} - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ViewCreateReq" - }, - "examples": { - "Example 1": { - "value": { - "title": "My Gallery View", - "type": 2, - "copy_from_id": null, - "fk_grp_col_id": null, - "fk_geo_data_col_id": null - } - } - } - } - } - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/galleries/{galleryViewId}": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "vw_1eq2wk2xe3a9j5" - }, - "name": "galleryViewId", - "in": "path", - "required": true, - "description": "Unique Gallery View ID" - } - ], - "patch": { - "summary": "Update Gallery View", - "operationId": "db-view-gallery-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number" - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GalleryUpdateReq" - }, - "examples": { - "Example 1": { - "value": { - "fk_cover_image_col_id": "cl_ib8l4j1kiu1efx", - "meta": null - } - } - } - } - } - }, - "description": "Update the Gallery View data with Gallery ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "get": { - "summary": "Get Gallery View", - "operationId": "db-view-gallery-read", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Gallery" - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "description": "Get the Gallery View data with Gallery ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/tables/{tableId}/kanbans": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "md_w9gpnaousnfss1", - "type": "string" - }, - "name": "tableId", - "in": "path", - "required": true, - "description": "Unique Table ID" - } - ], - "post": { - "summary": "Create Kanban View", - "operationId": "db-view-kanban-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/View" - }, - "examples": { - "Example 1": { - "value": { - "id": "vw_569sqsrp2vuff4", - "base_id": "ds_a95vextjl510z7", - "project_id": "p_slkm6i3v31q4bc", - "fk_model_id": "md_8hr3xndx8umuce", - "title": "Kanban-1", - "type": 4, - "is_default": null, - "show_system_fields": null, - "lock_type": "collaborative", - "uuid": null, - "password": null, - "show": true, - "order": 5, - "created_at": "2023-03-13T07:29:21.387Z", - "updated_at": "2023-03-13T07:29:21.387Z", - "meta": {} - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ViewCreateReq" - }, - "examples": { - "Example 1": { - "value": { - "title": "My Kanban View", - "type": 4, - "copy_from_id": null, - "fk_grp_col_id": "cl_g0a89q9xdry3lu", - "fk_geo_data_col_id": null - } - } - } - } - } - }, - "description": "Create a new Kanban View", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/kanbans/{kanbanViewId}": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "vw_1eq2wk2xe3a9j5" - }, - "name": "kanbanViewId", - "in": "path", - "required": true, - "description": "Unique Kanban View ID" - } - ], - "patch": { - "summary": "Update Kanban View", - "operationId": "db-view-kanban-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number" - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/KanbanUpdateReq" - }, - "examples": { - "Example 1": { - "value": { - "fk_grp_col_id": "cl_g0a89q9xdry3lu", - "fk_cover_image_col_id": "cl_ib8l4j1kiu1efx", - "meta": { - "cl_g0a89q9xdry3lu": [ - { - "id": "uncategorized", - "title": null, - "order": 0, - "color": "#c2f5e8", - "collapsed": false - }, - { - "id": "sl_ihyva6jx6dg0fc", - "fk_column_id": "cl_g0a89q9xdry3lu", - "title": "a", - "color": "#cfdffe", - "order": 1, - "collapsed": false - }, - { - "id": "sl_gqdm5v6t8aetoa", - "fk_column_id": "cl_g0a89q9xdry3lu", - "title": "b", - "color": "#d0f1fd", - "order": 2, - "collapsed": false - }, - { - "id": "sl_eipnl0kn7a9d3c", - "fk_column_id": "cl_g0a89q9xdry3lu", - "title": "cc", - "color": "#c2f5e8", - "order": 3, - "collapsed": false - }, - { - "id": "sl_dei8p2jq0cnlv0", - "fk_column_id": "cl_g0a89q9xdry3lu", - "title": "d", - "color": "#ffdaf6", - "order": 4, - "collapsed": false - } - ] - } - } - } - } - } - } - }, - "description": "Update the Kanban View data with Kanban ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "get": { - "summary": "Get Kanban View", - "operationId": "db-view-kanban-read", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Kanban" - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "description": "Get the Kanban View data by Kanban ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/tables/{tableId}/maps": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "md_w9gpnaousnfss1", - "type": "string" - }, - "name": "tableId", - "in": "path", - "required": true, - "description": "Unique Table ID" - } - ], - "post": { - "summary": "Create Map View", - "operationId": "db-view-map-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/View" - }, - "examples": { - "Example 1": { - "value": { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:46:31", - "fk_model_id": "md_mhs9z4r2ak98x0", - "id": "vw_lg052cnc1c26kf", - "is_default": 1, - "lock_type": "collaborative", - "meta": {}, - "order": 1, - "password": null, - "project_id": "p_xm3thidrblw4n7", - "show": 1, - "show_system_fields": null, - "title": "Sheet-1", - "type": 3, - "updated_at": "2023-03-02 17:46:31", - "uuid": null - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ViewCreateReq" - }, - "examples": { - "Example 1": { - "value": { - "title": "My Map View", - "type": 5, - "copy_from_id": null, - "fk_grp_col_id": null, - "fk_geo_data_col_id": "cl_uu1meolj00tlrq" - } - } - } - } - }, - "description": "" - }, - "description": "Create a new Map View", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/maps/{mapViewId}": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "vw_1eq2wk2xe3a9j5" - }, - "name": "mapViewId", - "in": "path", - "required": true, - "description": "Unique Map View ID" - } - ], - "patch": { - "summary": "Update Map View", - "operationId": "db-view-map-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number" - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/MapUpdateReq" - }, - "examples": { - "Example 1": { - "value": { - "fk_geo_data_col_id": "cl_8iw2o4ejzvdyna", - "meta": null - } - } - } - } - } - }, - "description": "Update the Map View data by Map ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "get": { - "summary": "Get Map View", - "operationId": "db-view-map-read", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Map" - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "description": "Get the Map View data by Map ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/projects/{projectId}/meta-diff": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - } - ], - "post": { - "summary": "Sync Meta", - "operationId": "project-meta-diff-sync", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "la6fd99uw6eao" - }, - "example": "The meta has been synchronized successfully" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "The meta has been synchronized successfully" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Project"], - "description": "Synchronise the meta data difference between NC_DB and external data sources ", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "get": { - "summary": "Meta Diff", - "operationId": "project-meta-diff-get", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["Project"], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "x-stoplight": { - "id": "awdkjwr7uultr" - }, - "type": "object", - "properties": { - "table_name": { - "type": "string", - "x-stoplight": { - "id": "jjj8ufafq1sd2" - }, - "description": "Table Name", - "example": "Table 1" - }, - "base_id": { - "type": "string", - "x-stoplight": { - "id": "smx2or6bv1xym" - }, - "description": "Base ID", - "example": "ds_rrplkgy0pq1f3c" - }, - "type": { - "type": "string", - "x-stoplight": { - "id": "zr19ahh1s6d13" - }, - "description": "Change Type", - "example": "table" - }, - "detectedChanges": { - "type": "array", - "x-stoplight": { - "id": "bptxla2y27aq6" - }, - "description": "Detected Changes", - "items": { - "x-stoplight": { - "id": "ob16o1ln7xy8o" - }, - "type": "object" - } - } - } - } - }, - "examples": { - "Example 1": { - "value": [ - { - "table_name": "_nc_m2m_uuv_xzru3m", - "base_id": "ds_rrplkgy0pq1f3c", - "type": "table", - "detectedChanges": [ - { - "type": "TABLE_NEW", - "msg": "New table" - }, - { - "type": "TABLE_RELATION_ADD", - "tn": "_nc_m2m_uuv_xzru3m", - "rtn": "Sheet-1", - "cn": "table1_id", - "rcn": "id", - "msg": "New relation added", - "relationType": "bt", - "cstn": "_nc_m2m_uuv_xzru3m_table1_id_foreign" - }, - { - "type": "TABLE_RELATION_ADD", - "tn": "_nc_m2m_uuv_xzru3m", - "rtn": "address", - "cn": "table2_id", - "rcn": "address_id", - "msg": "New relation added", - "relationType": "bt", - "cstn": "_nc_m2m_uuv_xzru3m_table2_id_foreign" - } - ] - } - ] - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Get the meta data difference between NC_DB and external data sources " - } - }, - "/api/v1/db/meta/projects/{projectId}/meta-diff/{baseId}": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - }, - { - "schema": { - "type": "string", - "pattern": "ds_j04jmxh5xg10lu" - }, - "name": "baseId", - "in": "path", - "required": true, - "description": "Unique Base ID" - } - ], - "post": { - "summary": "Synchronise Base Meta", - "operationId": "base-meta-diff-sync", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "acy7tx4rounqw" - }, - "example": "The base meta has been synchronized successfully" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "The base meta has been synchronized successfully" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Base"], - "description": "Synchronise the meta data difference between NC_DB and external data sources in a given Base", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "get": { - "summary": "Base Meta Diff", - "operationId": "base-meta-diff-get", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["Base"], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "x-stoplight": { - "id": "pav4jmel1ebeu" - }, - "type": "object", - "properties": { - "table_name": { - "type": "string", - "x-stoplight": { - "id": "xjw4k4httzmaf" - }, - "description": "Table Name", - "example": "Table 1" - }, - "base_id": { - "type": "string", - "x-stoplight": { - "id": "l1o3qhkgagsdl" - }, - "example": "ds_rrplkgy0pq1f3c", - "description": "Base ID" - }, - "type": { - "type": "string", - "x-stoplight": { - "id": "v5ciaygrj64uh" - }, - "description": "Change Type", - "example": "table" - }, - "detectedChanges": { - "type": "array", - "x-stoplight": { - "id": "wqn5noi0e46q8" - }, - "description": "Detected Changes", - "items": { - "x-stoplight": { - "id": "r2roo274wquvf" - }, - "type": "object" - } - } - } - } - }, - "examples": { - "Example 1": { - "value": [ - { - "table_name": "_nc_m2m_uuv_xzru3m", - "base_id": "ds_rrplkgy0pq1f3c", - "type": "table", - "detectedChanges": [ - { - "type": "TABLE_NEW", - "msg": "New table" - }, - { - "type": "TABLE_RELATION_ADD", - "tn": "_nc_m2m_uuv_xzru3m", - "rtn": "Sheet-1", - "cn": "table1_id", - "rcn": "id", - "msg": "New relation added", - "relationType": "bt", - "cstn": "_nc_m2m_uuv_xzru3m_table1_id_foreign" - }, - { - "type": "TABLE_RELATION_ADD", - "tn": "_nc_m2m_uuv_xzru3m", - "rtn": "address", - "cn": "table2_id", - "rcn": "address_id", - "msg": "New relation added", - "relationType": "bt", - "cstn": "_nc_m2m_uuv_xzru3m_table2_id_foreign" - } - ] - } - ] - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Get the meta data difference between NC_DB and external data sources in a given Base" - } - }, - "/api/v1/db/meta/projects/{projectId}/has-empty-or-null-filters": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - } - ], - "get": { - "summary": "List Empty & Null Filter", - "operationId": "project-has-empty-or-null-filters", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["Project"], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": {} - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Check if a project contains empty and null filters. Used in `Show NULL and EMPTY in Filter` in Project Setting.", - "x-internal": true - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - } - ], - "get": { - "summary": "List Table Rows", - "operationId": "db-table-row-list", - "description": "List all table rows in a given table and project", - "tags": ["DB Table Row"], - "parameters": [ - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "fields", - "description": "Which fields to be shown" - }, - { - "schema": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "type": "string" - } - ] - }, - "in": "query", - "name": "sort", - "description": "The result will be sorted based on `sort` query" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where", - "description": "Extra filtering" - }, - { - "schema": { - "type": "integer", - "minimum": 0 - }, - "in": "query", - "name": "offset", - "description": "Offset in rows" - }, - { - "schema": { - "type": "integer", - "minimum": 1 - }, - "in": "query", - "name": "limit", - "description": "Limit in rows" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "sortArrJson", - "description": "Used for multiple sort queries" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "filterArrJson", - "description": "Used for multiple filter queries" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "list": { - "type": "array", - "x-stoplight": { - "id": "g92aqxk869a7o" - }, - "description": "List of data objects", - "items": { - "x-stoplight": { - "id": "rnbt8ubciknfd" - }, - "type": "object" - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated", - "x-stoplight": { - "id": "7f38yyzdg03x5" - }, - "description": "Paginated Info" - } - }, - "required": ["list", "pageInfo"] - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "Id": 1, - "Title": "baz", - "SingleSelect": null, - "Sheet-1 List": [ - { - "Id": 1, - "Title": "baz" - } - ], - "LTAR": [ - { - "Id": 1, - "Title": "baz" - } - ] - }, - { - "Id": 2, - "Title": "foo", - "SingleSelect": "a", - "Sheet-1 List": [ - { - "Id": 2, - "Title": "foo" - } - ], - "LTAR": [ - { - "Id": 2, - "Title": "foo" - } - ] - }, - { - "Id": 3, - "Title": "bar", - "SingleSelect": "b", - "Sheet-1 List": [], - "LTAR": [] - } - ], - "pageInfo": { - "totalRows": 3, - "page": 1, - "pageSize": 25, - "isFirstPage": true, - "isLastPage": true - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - } - }, - "post": { - "summary": "Create Table Row", - "operationId": "db-table-row-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": {} - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Row"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "examples": { - "Example 1": { - "value": { - "Id": 1, - "Title": "foo", - "CreatedAt": "2023-03-11T09:10:53.567Z", - "UpdatedAt": "2023-03-11T09:10:53.567Z" - } - } - } - } - } - }, - "description": "Create a new row in a given table and project.", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/find-one": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - } - ], - "get": { - "summary": "Find One Table Row", - "operationId": "db-table-row-find-one", - "description": "Return the first result of the target Table Row", - "tags": ["DB Table Row"], - "parameters": [ - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "fields" - }, - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "sort" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "examples": { - "Example 1": { - "value": { - "Id": 1, - "Title": "foo", - "CreatedAt": "2023-03-11T09:10:53.567Z", - "UpdatedAt": "2023-03-11T09:10:53.567Z" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - } - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/groupby": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "column_name", - "description": "Column name of the column you want to group by, eg. `column_name=column1`" - } - ], - "get": { - "summary": "Group By Table Row", - "operationId": "db-table-row-group-by", - "description": "Get the result grouped by the given query", - "tags": ["DB Table Row"], - "parameters": [ - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "sort" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where" - }, - { - "schema": { - "type": "integer", - "minimum": 1 - }, - "in": "query", - "name": "limit" - }, - { - "schema": { - "type": "integer", - "minimum": 0 - }, - "in": "query", - "name": "offset" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": {} - } - } - } - } - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/views/{viewName}/group/{columnId}": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string", - "example": "p_tbhl1hnycvhe5l" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string", - "example": "md_5hua2iqloqirhd" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "type": "string", - "example": "vw_mldv0a5mtwh1la" - }, - "name": "viewName", - "in": "path", - "required": true, - "description": "View Name" - }, - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "cl_8iw2o4ejzvdyna", - "type": "string" - }, - "name": "columnId", - "in": "path", - "required": true, - "description": "Unique Column ID" - } - ], - "get": { - "summary": "Table Group by Column", - "operationId": "db-view-row-grouped-data-list", - "description": "Get the grouped data By Column ID. Used in Kanban View.", - "tags": ["DB View Row"], - "parameters": [ - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "fields" - }, - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "sort" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where" - }, - { - "schema": {}, - "in": "query", - "name": "nested", - "description": "Query params for nested data" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": {} - }, - "examples": { - "Example 1": { - "value": [ - { - "key": "a", - "value": { - "list": [ - { - "Id": 2, - "Title": "foo", - "SingleSelect": "a" - } - ], - "pageInfo": { - "totalRows": 1, - "page": 1, - "pageSize": 25, - "isFirstPage": true, - "isLastPage": true - } - } - }, - { - "key": "b", - "value": { - "list": [ - { - "Id": 3, - "Title": "bar", - "SingleSelect": "b" - } - ], - "pageInfo": { - "totalRows": 1, - "page": 1, - "pageSize": 25, - "isFirstPage": true, - "isLastPage": true - } - } - }, - { - "key": null, - "value": { - "list": [ - { - "Id": 1, - "Title": "baz", - "SingleSelect": null - }, - { - "Id": 5, - "Title": "xyz", - "SingleSelect": null - } - ], - "pageInfo": { - "totalRows": 2, - "page": 1, - "pageSize": 25, - "isFirstPage": true, - "isLastPage": true - } - } - } - ] - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - } - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/group/{columnId}": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string", - "example": "p_tbhl1hnycvhe5l" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string", - "example": "md_5hua2iqloqirhd" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "cl_8iw2o4ejzvdyna", - "type": "string" - }, - "name": "columnId", - "in": "path", - "required": true, - "description": "Unique Column ID" - } - ], - "get": { - "summary": "Table Group by Column", - "operationId": "db-table-row-grouped-data-list", - "description": "Get the grouped data By Column ID. Used in Kanban View.", - "tags": ["DB Table Row"], - "parameters": [ - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "fields" - }, - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "sort" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where" - }, - { - "schema": {}, - "in": "query", - "name": "nested", - "description": "Query params for nested data" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": {} - }, - "examples": { - "Example 1": { - "value": [ - { - "key": "a", - "value": { - "list": [ - { - "Id": 2, - "Title": "foo", - "SingleSelect": "a" - } - ], - "pageInfo": { - "totalRows": 1, - "page": 1, - "pageSize": 25, - "isFirstPage": true, - "isLastPage": true - } - } - }, - { - "key": "b", - "value": { - "list": [ - { - "Id": 3, - "Title": "bar", - "SingleSelect": "b" - } - ], - "pageInfo": { - "totalRows": 1, - "page": 1, - "pageSize": 25, - "isFirstPage": true, - "isLastPage": true - } - } - }, - { - "key": null, - "value": { - "list": [ - { - "Id": 1, - "Title": "baz", - "SingleSelect": null - }, - { - "Id": 5, - "Title": "xyz", - "SingleSelect": null - } - ], - "pageInfo": { - "totalRows": 2, - "page": 1, - "pageSize": 25, - "isFirstPage": true, - "isLastPage": true - } - } - } - ] - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - } - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/views/{viewName}": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "type": "string" - }, - "name": "viewName", - "in": "path", - "required": true - } - ], - "get": { - "summary": "List Table View Rows", - "operationId": "db-view-row-list", - "description": "List all table view rows", - "tags": ["DB View Row"], - "parameters": [ - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "fields" - }, - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "sort" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where" - }, - { - "schema": {}, - "in": "query", - "name": "nested", - "description": "Query params for nested data" - }, - { - "schema": { - "type": "number" - }, - "in": "query", - "name": "offset" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "list": { - "type": "array", - "x-stoplight": { - "id": "okd8utzm9xqet" - }, - "description": "List of table view rows", - "items": { - "x-stoplight": { - "id": "j758lsjv53o4q" - }, - "type": "object" - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated", - "x-stoplight": { - "id": "hylgqzgm8yhye" - }, - "description": "Paginated Info" - } - }, - "required": ["list", "pageInfo"] - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "Id": 1, - "Title": "baz", - "SingleSelect": null, - "Sheet-1 List": [ - { - "Id": 1, - "Title": "baz" - } - ], - "LTAR": [ - { - "Id": 1, - "Title": "baz" - } - ] - }, - { - "Id": 2, - "Title": "foo", - "SingleSelect": "a", - "Sheet-1 List": [ - { - "Id": 2, - "Title": "foo" - } - ], - "LTAR": [ - { - "Id": 2, - "Title": "foo" - } - ] - }, - { - "Id": 3, - "Title": "bar", - "SingleSelect": "b", - "Sheet-1 List": [], - "LTAR": [] - } - ], - "pageInfo": { - "totalRows": 3, - "page": 1, - "pageSize": 25, - "isFirstPage": true, - "isLastPage": true - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - } - }, - "post": { - "summary": "Create Table View Row", - "operationId": "db-view-row-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "examples": { - "Example 1": { - "value": { - "Id": 1, - "col1": "foo", - "col2": "bar", - "CreatedAt": "2023-03-11T08:48:25.598Z", - "UpdatedAt": "2023-03-11T08:48:25.598Z" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View Row"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "examples": { - "Example 1": { - "value": { - "col1": "foo", - "col2": "bar" - } - } - } - } - } - }, - "description": "Create a new row in the given Table View" - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/views/{viewName}/find-one": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "type": "string" - }, - "name": "viewName", - "in": "path", - "required": true - } - ], - "get": { - "summary": "Find One Table View Row", - "operationId": "db-view-row-find-one", - "description": "Return the first result of table view rows with the given query", - "tags": ["DB View Row"], - "parameters": [ - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "fields" - }, - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "sort" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where" - }, - { - "schema": {}, - "in": "query", - "name": "nested", - "description": "Query params for nested data" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "examples": { - "Example 1": { - "value": { - "Id": 1, - "Title": "foo", - "CreatedAt": "2023-03-11T09:10:53.567Z", - "UpdatedAt": "2023-03-11T09:10:53.567Z" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - } - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/views/{viewName}/groupby": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "type": "string" - }, - "name": "viewName", - "in": "path", - "required": true - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "column_name", - "description": "Column name of the column you want to group by, eg. `column_name=column1`" - } - ], - "get": { - "summary": "Group By Table View Row", - "operationId": "db-view-row-group-by", - "description": "Get the table view rows groupe by the given query", - "tags": ["DB View Row"], - "parameters": [ - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "sort" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where" - }, - { - "schema": { - "type": "integer", - "minimum": 1 - }, - "in": "query", - "name": "limit" - }, - { - "schema": { - "type": "integer", - "minimum": 0 - }, - "in": "query", - "name": "offset" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": {} - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - } - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/views/{viewName}/count": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "type": "string", - "example": "vw_75neroyqdye94k" - }, - "name": "viewName", - "in": "path", - "required": true, - "description": "View Name" - } - ], - "get": { - "summary": "Count Table View Rows", - "operationId": "db-view-row-count", - "description": "Count how many rows in the given Table View", - "tags": ["DB View Row"], - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where" - }, - { - "schema": {}, - "in": "query", - "name": "nested", - "description": "Query params for nested data" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "count": { - "type": "number", - "x-stoplight": { - "id": "hwq29x70rcipi" - } - } - } - }, - "examples": { - "Example 1": { - "value": { - "count": 25 - } - } - } - } - } - } - } - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/views/{viewName}/{rowId}": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "type": "string", - "example": "vw_75neroyqdye94k" - }, - "name": "viewName", - "in": "path", - "required": true, - "description": "View Name" - }, - { - "schema": { - "example": "1" - }, - "name": "rowId", - "in": "path", - "required": true, - "description": "Unique Row ID" - } - ], - "get": { - "summary": "Get Table View Row", - "operationId": "db-view-row-read", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {} - }, - "examples": { - "Example 1": { - "value": { - "Id": 1, - "Title": "foo", - "CreatedAt": "2023-03-11T09:11:47.437Z", - "UpdatedAt": "2023-03-11T09:11:47.784Z" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Get the target Table View Row", - "tags": ["DB View Row"], - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "patch": { - "summary": "Update Table View Row", - "operationId": "db-view-row-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "examples": { - "Example 1": { - "value": { - "Id": 1, - "Title": "bar", - "CreatedAt": "2023-03-11T09:11:47.437Z", - "UpdatedAt": "2023-03-11T09:20:21.133Z" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View Row"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "examples": { - "Example 1": { - "value": { - "Title": "bar" - } - } - } - } - } - }, - "description": "Update the target Table View Row", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "delete": { - "summary": "Delete Table View Row", - "operationId": "db-view-row-delete", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number" - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View Row"], - "description": "Delete the target Table View Row", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/views/{viewName}/{rowId}/exist": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "type": "string" - }, - "name": "viewName", - "in": "path", - "required": true - }, - { - "schema": { - "example": "1" - }, - "name": "rowId", - "in": "path", - "required": true, - "description": "Unique Row ID" - } - ], - "get": { - "summary": "Does Table View Row Exist", - "operationId": "db-view-row-exist", - "responses": { - "201": { - "description": "Created", - "content": { - "application/json": { - "schema": { - "type": "number" - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Check row with provided primary key exists or not", - "tags": ["DB View Row"], - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/{rowId}": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "example": "1" - }, - "name": "rowId", - "in": "path", - "required": true, - "description": "Unique Row ID" - } - ], - "get": { - "summary": "Get Table Row", - "operationId": "db-table-row-read", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {} - }, - "examples": { - "Example 1": { - "value": { - "Id": 1, - "Title": "foo", - "CreatedAt": "2023-03-11T09:11:47.437Z", - "UpdatedAt": "2023-03-11T09:11:47.784Z" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Get the Table Row by Row ID", - "tags": ["DB Table Row"], - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "patch": { - "summary": "Update Table Row", - "operationId": "db-table-row-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "examples": { - "Example 1": { - "value": { - "Id": 1, - "Title": "bar", - "CreatedAt": "2023-03-11T09:11:47.437Z", - "UpdatedAt": "2023-03-11T09:20:21.133Z" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Row"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "examples": { - "Example 1": { - "value": { - "Title": "bar" - } - } - } - } - } - }, - "description": "Update the Table Row", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "delete": { - "summary": "Delete Table Row", - "operationId": "db-table-row-delete", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number" - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Row"], - "description": "Delete the Table Row", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/{rowId}/exist": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "example": "1" - }, - "name": "rowId", - "in": "path", - "required": true, - "description": "Unique Row ID" - } - ], - "get": { - "summary": "Does Table Row Exist", - "operationId": "db-table-row-exist", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number" - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "check row with provided primary key exists or not", - "tags": ["DB Table Row"], - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/data/bulk/{orgs}/{projectName}/{tableName}": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - } - ], - "post": { - "summary": "Bulk Insert Table Rows", - "operationId": "db-table-row-bulk-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "description": "List of returned IDs", - "items": { - "x-stoplight": { - "id": "dbkhyd3mnajax" - }, - "type": "object", - "properties": { - "id": { - "type": "string", - "x-stoplight": { - "id": "lnwqjl14f287f" - } - } - } - } - }, - "examples": { - "Example 1": { - "value": [ - { - "id": 1 - }, - { - "id": 2 - } - ] - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Row"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "array", - "description": "List of data objects", - "items": { - "x-stoplight": { - "id": "7u0mp8nzlvysz" - }, - "type": "object" - } - }, - "examples": { - "Example 1": { - "value": [ - { - "Title": "abc" - }, - { - "Title": "def" - } - ] - } - } - } - }, - "description": "" - }, - "description": "Bulk insert table rows in one go.", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "patch": { - "summary": "Bulk Update Table Rows by IDs", - "operationId": "db-table-row-bulk-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "description": "List of returned values. 1 means successful. 0 means failed.", - "items": { - "x-stoplight": { - "id": "ga0xhsahovdt7" - }, - "type": "number" - } - }, - "examples": { - "Example 1": { - "value": [1, 1] - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Row"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "array", - "description": "List of data objects", - "items": { - "x-stoplight": { - "id": "q2xtbf29i1s5n" - }, - "type": "object" - } - }, - "examples": { - "Example 1": { - "value": [ - { - "Id": "1", - "Title": "123" - }, - { - "Id": "2", - "Title": "456" - } - ] - } - } - } - } - }, - "description": "Bulk Update Table Rows by given IDs", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "delete": { - "summary": "Bulk Delete Table Rows by IDs", - "operationId": "db-table-row-bulk-delete", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "x-stoplight": { - "id": "b9o9o2r6ipho9" - }, - "type": "number" - } - }, - "examples": { - "Example 1": { - "value": [1, 1] - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Row"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "x-stoplight": { - "id": "sd8udhhjnqiay" - }, - "type": "object" - } - }, - "examples": { - "Example 1": { - "value": [ - { - "Id": "1" - }, - { - "Id": "2" - } - ] - } - } - } - }, - "description": "" - }, - "description": "Bulk Delete Table Rows by given IDs", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/data/bulk/{orgs}/{projectName}/{tableName}/all": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where" - } - ], - "patch": { - "summary": "Bulk Update Table Rows with Conditions", - "operationId": "db-table-row-bulk-update-all", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": {}, - "examples": { - "Example 1": { - "value": [ - { - "Id": "1" - }, - { - "Id": "2" - } - ] - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Row"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "examples": { - "Example 1": { - "value": { - "Title": "foo" - } - } - } - } - } - }, - "description": "Bulk Update all Table Rows if the condition is true", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "delete": { - "summary": "Bulk Delete Table Rows with Conditions", - "operationId": "db-table-row-bulk-delete-all", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "x-stoplight": { - "id": "9gcl3ok7is3y0" - }, - "type": "object" - } - }, - "examples": { - "Example 1": { - "value": [1, 1] - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Row"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "examples": { - "Example 1": { - "value": { - "Title": "foo" - } - } - } - } - } - }, - "description": "Bulk Delete all Table Rows if the condition is true", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/views/{viewName}/export/{type}": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "type": "string" - }, - "name": "viewName", - "in": "path", - "required": true - }, - { - "schema": { - "type": "string", - "enum": ["csv", "excel"] - }, - "name": "type", - "in": "path", - "required": true - } - ], - "get": { - "summary": "Export Table View Rows", - "operationId": "db-view-row-export", - "description": "Export Table View Rows by CSV or Excel", - "tags": ["DB View Row"], - "wrapped": true, - "responses": { - "200": { - "description": "OK", - "content": { - "application/octet-stream": { - "schema": {} - } - }, - "headers": { - "nc-export-offset": { - "schema": { - "type": "integer" - }, - "description": "The starting offset of the next set of rows" - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/export/{type}": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "type": "string", - "enum": ["csv", "excel"] - }, - "name": "type", - "in": "path", - "required": true - } - ], - "get": { - "summary": "Export Table View Rows", - "operationId": "db-table-row-csv-export", - "description": "Export Table View Rows by CSV or Excel", - "tags": ["DB Table Row"], - "wrapped": true, - "responses": { - "200": { - "description": "OK", - "content": { - "application/octet-stream": { - "schema": {} - } - }, - "headers": { - "nc-export-offset": { - "schema": { - "type": "integer" - }, - "description": "The starting offset of the next set of rows" - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/{rowId}/{relationType}/{columnName}": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "example": "1" - }, - "name": "rowId", - "in": "path", - "required": true, - "description": "Unique Row ID" - }, - { - "schema": { - "type": "string", - "enum": ["mm", "hm", "bt"] - }, - "name": "relationType", - "in": "path", - "required": true, - "description": "Relation Type" - }, - { - "schema": { - "type": "string" - }, - "name": "columnName", - "in": "path", - "required": true, - "description": "Column Name" - } - ], - "get": { - "summary": "List Nested Relations Rows", - "operationId": "db-table-row-nested-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": {} - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Row"], - "parameters": [ - { - "schema": { - "type": "integer", - "minimum": 1 - }, - "in": "query", - "name": "limit" - }, - { - "schema": { - "type": "integer", - "minimum": 0 - }, - "in": "query", - "name": "offset" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "description": "List all nested relations rows" - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/{rowId}/{relationType}/{columnName}/{refRowId}": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "example": "1" - }, - "name": "rowId", - "in": "path", - "required": true, - "description": "Unique Row ID" - }, - { - "schema": { - "type": "string", - "enum": ["mm", "hm", "bt"] - }, - "name": "relationType", - "in": "path", - "required": true - }, - { - "schema": { - "type": "string" - }, - "name": "columnName", - "in": "path", - "required": true - }, - { - "schema": { - "type": "string" - }, - "name": "refRowId", - "in": "path", - "required": true - } - ], - "post": { - "summary": "Create Nested Relations Row", - "operationId": "db-table-row-nested-add", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "m6jox00hxgd6s" - }, - "example": "The relation data has been created successfully" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "The relation data has been created successfully" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Row"], - "parameters": [ - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "fields", - "description": "Which fields to be shown" - }, - { - "schema": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "type": "string" - } - ] - }, - "in": "query", - "name": "sort", - "description": "The result will be sorted based on `sort` query" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where", - "description": "Extra filtering" - }, - { - "schema": { - "type": "integer", - "minimum": 0 - }, - "in": "query", - "name": "offset", - "description": "Offset in rows" - }, - { - "schema": { - "type": "integer", - "minimum": 1 - }, - "in": "query", - "name": "limit", - "description": "Limit in rows" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "sortArrJson", - "description": "Used for multiple sort queries" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "filterArrJson", - "description": "Used for multiple filter queries" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "description": "Create a new nested relations row" - }, - "delete": { - "summary": "Delete Nested Relations Row", - "operationId": "db-table-row-nested-remove", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "vo3x8xf3j2xlb" - }, - "example": "The relation data has been deleted successfully" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "The relation data has been deleted successfully" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Row"], - "description": "Delete a new nested relations row", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/{rowId}/{relationType}/{columnName}/exclude": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "example": "1" - }, - "name": "rowId", - "in": "path", - "required": true, - "description": "Unique Row ID" - }, - { - "schema": { - "type": "string", - "enum": ["mm", "hm", "bt"] - }, - "name": "relationType", - "in": "path", - "required": true - }, - { - "schema": { - "type": "string" - }, - "name": "columnName", - "in": "path", - "required": true - } - ], - "get": { - "summary": "Referenced Table Rows Excluding Current Record's Children / Parent", - "operationId": "db-table-row-nested-children-excluded-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": {} - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Row"], - "parameters": [ - { - "schema": { - "type": "integer", - "minimum": 1 - }, - "in": "query", - "name": "limit" - }, - { - "schema": { - "type": "integer", - "minimum": 0 - }, - "in": "query", - "name": "offset" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "description": "Get the table rows but exculding the current record's children and parent" - } - }, - "/api/v1/db/public/shared-view/{sharedViewUuid}/group/{columnId}": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "24a6d0bb-e45d-4b1a-bfef-f492d870de9f" - }, - "name": "sharedViewUuid", - "in": "path", - "required": true, - "description": "Shared View UUID" - }, - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "cl_8iw2o4ejzvdyna", - "type": "string" - }, - "name": "columnId", - "in": "path", - "required": true, - "description": "Unique Column ID" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "xc-password", - "description": "Shared view password" - } - ], - "get": { - "summary": "List Shared View Grouped Data", - "operationId": "public-grouped-data-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "x-stoplight": { - "id": "bldcv1pwuri5s" - }, - "type": "object", - "properties": { - "key": { - "type": "string", - "x-stoplight": { - "id": "n0ujmkbyhgsxo" - }, - "description": "The Grouped Key" - }, - "value": { - "type": "object", - "x-stoplight": { - "id": "0xsi3jvwn7duo" - }, - "description": "the paginated result of the given key", - "required": ["list", "pageInfo"], - "properties": { - "list": { - "type": "array", - "x-stoplight": { - "id": "jw8dmo16txbjv" - }, - "description": "List of the target data", - "items": { - "x-stoplight": { - "id": "xcu8vxmf5ygyi" - }, - "type": "object" - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated", - "x-stoplight": { - "id": "1gsbgwi9bg8s5" - }, - "description": "Paginated Info" - } - } - } - }, - "required": ["key", "value"] - } - }, - "examples": { - "Example 1": { - "value": [ - { - "key": "a", - "value": { - "list": [ - { - "Id": 2, - "Title": "foo", - "s": "a" - } - ], - "pageInfo": { - "totalRows": 1, - "page": 1, - "pageSize": 25, - "isFirstPage": true, - "isLastPage": true - } - } - }, - { - "key": "b", - "value": { - "list": [ - { - "Id": 3, - "Title": "bar", - "s": "b" - } - ], - "pageInfo": { - "totalRows": 1, - "page": 1, - "pageSize": 25, - "isFirstPage": true, - "isLastPage": true - } - } - }, - { - "key": null, - "value": { - "list": [ - { - "Id": 1, - "Title": "baz", - "s": null - } - ], - "pageInfo": { - "totalRows": 1, - "page": 1, - "pageSize": 25, - "isFirstPage": true, - "isLastPage": true - } - } - } - ] - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Public"], - "parameters": [ - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "fields", - "description": "Which fields to be shown" - }, - { - "schema": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "type": "string" - } - ] - }, - "in": "query", - "name": "sort", - "description": "The result will be sorted based on `sort` query" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where", - "description": "Extra filtering" - }, - { - "schema": { - "type": "integer", - "minimum": 0 - }, - "in": "query", - "name": "offset", - "description": "Offset in rows" - }, - { - "schema": { - "type": "integer", - "minimum": 1 - }, - "in": "query", - "name": "limit", - "description": "Limit in rows" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "sortArrJson", - "description": "Used for multiple sort queries" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "filterArrJson", - "description": "Used for multiple filter queries" - } - ], - "description": "List Shared View Grouped Data" - } - }, - "/api/v1/db/public/shared-view/{sharedViewUuid}/rows": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "24a6d0bb-e45d-4b1a-bfef-f492d870de9f" - }, - "name": "sharedViewUuid", - "in": "path", - "required": true, - "description": "Shared View UUID" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "xc-password", - "description": "Shared view password" - } - ], - "get": { - "summary": "List Shared View Rows", - "operationId": "public-data-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SharedViewList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:46:31", - "fk_model_id": "md_mhs9z4r2ak98x0", - "id": "vw_lg052cnc1c26kf", - "is_default": 1, - "lock_type": "collaborative", - "meta": {}, - "order": 1, - "password": null, - "project_id": "p_xm3thidrblw4n7", - "show": 1, - "show_system_fields": null, - "title": "Sheet-1", - "type": 3, - "updated_at": "2023-03-02 17:46:31", - "uuid": null, - "view": { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:46:31", - "fk_view_id": "vw_lg052cnc1c26kf", - "meta": null, - "project_id": "p_xm3thidrblw4n7", - "row_height": null, - "updated_at": "2023-03-02 17:46:31", - "uuid": null - } - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Public"], - "parameters": [ - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "fields", - "description": "Which fields to be shown" - }, - { - "schema": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "type": "string" - } - ] - }, - "in": "query", - "name": "sort", - "description": "The result will be sorted based on `sort` query" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where", - "description": "Extra filtering" - }, - { - "schema": { - "type": "integer", - "minimum": 0 - }, - "in": "query", - "name": "offset", - "description": "Offset in rows" - }, - { - "schema": { - "type": "integer", - "minimum": 1 - }, - "in": "query", - "name": "limit", - "description": "Limit in rows" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "sortArrJson", - "description": "Used for multiple sort queries" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "filterArrJson", - "description": "Used for multiple filter queries" - } - ], - "description": "List all shared view rows" - }, - "post": { - "summary": "Create Share View Row", - "operationId": "public-data-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "examples": { - "Example 1": { - "value": { - "Id": 1, - "col1": "foo", - "col2": "bar", - "CreatedAt": "2023-03-11T08:48:25.598Z", - "UpdatedAt": "2023-03-11T08:48:25.598Z" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "multipart/form-data": {} - }, - "description": "" - }, - "tags": ["Public"], - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "xc-password", - "description": "Shared view password" - } - ], - "description": "Create a new row for the target shared view" - } - }, - "/api/v1/db/public/shared-view/{sharedViewUuid}/rows/{rowId}/{relationType}/{columnName}": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "24a6d0bb-e45d-4b1a-bfef-f492d870de9f" - }, - "name": "sharedViewUuid", - "in": "path", - "required": true, - "description": "Shared View UUID" - }, - { - "schema": { - "example": "1" - }, - "name": "rowId", - "in": "path", - "required": true, - "description": "Unique Row ID" - }, - { - "schema": { - "type": "string", - "enum": ["mm", "hm", "bt"] - }, - "name": "relationType", - "in": "path", - "required": true, - "description": "Relation Type" - }, - { - "schema": { - "type": "string" - }, - "name": "columnName", - "in": "path", - "required": true, - "description": "Column Name" - } - ], - "get": { - "summary": "List Nested List Data", - "operationId": "public-data-nested-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "list": { - "type": "array", - "x-stoplight": { - "id": "gvblksjzjfyg7" - }, - "description": "List of data objects", - "items": { - "x-stoplight": { - "id": "8assgoc1vtcs9" - }, - "type": "object" - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated", - "x-stoplight": { - "id": "if546w1yuo6fw" - }, - "description": "Paginated info" - } - }, - "required": ["list", "pageInfo"] - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "Id": 1, - "Title": "foo", - "CreatedAt": "2023-03-11T08:41:41.356Z", - "UpdatedAt": "2023-03-11T08:41:41.356Z" - }, - { - "Id": 2, - "Title": "bar", - "CreatedAt": "2023-03-11T08:41:45.330Z", - "UpdatedAt": "2023-03-11T08:41:45.330Z" - }, - { - "Id": 3, - "Title": "baz", - "CreatedAt": "2023-03-11T08:48:25.598Z", - "UpdatedAt": "2023-03-11T08:48:25.598Z" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "pageSize": 1, - "sort": "string", - "totalRows": 3 - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Public"], - "parameters": [ - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "fields", - "description": "Which fields to be shown" - }, - { - "schema": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "type": "string" - } - ] - }, - "in": "query", - "name": "sort", - "description": "The result will be sorted based on `sort` query" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where", - "description": "Extra filtering" - }, - { - "schema": { - "type": "integer", - "minimum": 0 - }, - "in": "query", - "name": "offset", - "description": "Offset in rows" - }, - { - "schema": { - "type": "integer", - "minimum": 1 - }, - "in": "query", - "name": "limit", - "description": "Limit in rows" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "sortArrJson", - "description": "Used for multiple sort queries" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "filterArrJson", - "description": "Used for multiple filter queries" - } - ], - "description": "List all nested list data in a given shared view" - } - }, - "/api/v1/db/public/shared-view/{sharedViewUuid}/rows/export/{type}": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "76d44b86-bc65-4500-8956-ab512c80ab25" - }, - "name": "sharedViewUuid", - "in": "path", - "required": true, - "description": "Shared View UUID" - }, - { - "schema": { - "type": "string", - "enum": ["csv", "excel"], - "example": "csv" - }, - "name": "type", - "in": "path", - "required": true, - "description": "Export Type" - } - ], - "get": { - "summary": "Export Rows in Share View", - "operationId": "public-csv-export", - "description": "Export all rows in Share View in a CSV / Excel Format", - "wrapped": true, - "responses": { - "200": { - "description": "OK", - "content": { - "application/octet-stream": { - "schema": {} - } - }, - "headers": { - "nc-export-offset": { - "schema": { - "type": "integer" - }, - "description": "The starting offset of the next set of rows" - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Public"] - } - }, - "/api/v1/db/public/shared-view/{sharedViewUuid}/nested/{columnName}": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "24a6d0bb-e45d-4b1a-bfef-f492d870de9f" - }, - "name": "sharedViewUuid", - "in": "path", - "required": true, - "description": "Shared View UUID" - }, - { - "schema": { - "type": "string" - }, - "name": "columnName", - "in": "path", - "required": true, - "description": "Column Name" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "xc-password", - "description": "Shared view password" - } - ], - "get": { - "summary": "List Nested Data Relation", - "operationId": "public-data-relation-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": {} - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "parameters": [ - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "fields", - "description": "Which fields to be shown" - }, - { - "schema": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "type": "string" - } - ] - }, - "in": "query", - "name": "sort", - "description": "The result will be sorted based on `sort` query" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where", - "description": "Extra filtering" - }, - { - "schema": { - "type": "integer", - "minimum": 0 - }, - "in": "query", - "name": "offset", - "description": "Offset in rows" - }, - { - "schema": { - "type": "integer", - "minimum": 1 - }, - "in": "query", - "name": "limit", - "description": "Limit in rows" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "sortArrJson", - "description": "Used for multiple sort queries" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "filterArrJson", - "description": "Used for multiple filter queries" - } - ], - "tags": ["Public"], - "description": "List Nested Data Relation" - } - }, - "/api/v1/db/public/shared-base/{sharedBaseUuid}/meta": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "24a6d0bb-e45d-4b1a-bfef-f492d870de9f" - }, - "name": "sharedBaseUuid", - "in": "path", - "required": true, - "description": "Shared Base UUID" - } - ], - "get": { - "summary": "Get Share Base Meta", - "operationId": "public-shared-base-get", - "description": "Get Share Base Meta", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "project_id": { - "type": "string", - "description": "Project ID" - } - } - }, - "examples": { - "Example 1": { - "value": { - "project_id": "p_63b4q0qengen1x" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Public"] - } - }, - "/api/v1/db/public/shared-view/{sharedViewUuid}/meta": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "24a6d0bb-e45d-4b1a-bfef-f492d870de9f" - }, - "name": "sharedViewUuid", - "in": "path", - "required": true, - "description": "Shared View UUID" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "xc-password", - "description": "Shared view password" - } - ], - "get": { - "summary": "Get Share View Meta", - "operationId": "public-shared-view-meta-get", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/View" - }, - { - "type": "object", - "properties": { - "relatedMetas": {}, - "client": { - "type": "string" - }, - "base_id": { - "type": "string" - }, - "columns": { - "allOf": [ - { - "anyOf": [ - { - "$ref": "#/components/schemas/GridColumn" - }, - { - "$ref": "#/components/schemas/FormColumn" - }, - { - "$ref": "#/components/schemas/GalleryColumn" - } - ] - }, - { - "$ref": "#/components/schemas/Column" - } - ] - }, - "model": { - "$ref": "#/components/schemas/Table" - } - } - }, - { - "type": "object", - "properties": { - "view": { - "anyOf": [ - { - "$ref": "#/components/schemas/Form" - }, - { - "$ref": "#/components/schemas/Grid" - }, - { - "$ref": "#/components/schemas/Gallery" - } - ] - } - } - } - ] - } - }, - "application/xml": { - "schema": {} - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Public"], - "description": "Get Share View Meta" - } - }, - "/api/v1/db/meta/audits/comments": { - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "get": { - "summary": "List Comments in Audit", - "operationId": "utils-comment-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "list": { - "x-stoplight": { - "id": "5zto1xohsngbu" - }, - "type": "array", - "items": { - "$ref": "#/components/schemas/Audit", - "x-stoplight": { - "id": "d22zkup0c0l80" - } - } - } - }, - "required": ["list"] - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "id": "adt_3sii7erfwrlegb", - "user": "w@nocodb.com", - "ip": null, - "base_id": null, - "project_id": "p_63b4q0qengen1x", - "fk_model_id": "md_5mipbdg6ketmv8", - "row_id": "1", - "op_type": "COMMENT", - "op_sub_type": null, - "status": null, - "description": "bar", - "details": null, - "created_at": "2023-03-13T09:39:14.225Z", - "updated_at": "2023-03-13T09:39:14.225Z" - }, - { - "id": "adt_fezs668qbxj8gc", - "user": "w@nocodb.com", - "ip": null, - "base_id": null, - "project_id": "p_63b4q0qengen1x", - "fk_model_id": "md_5mipbdg6ketmv8", - "row_id": "1", - "op_type": "COMMENT", - "op_sub_type": null, - "status": null, - "description": "foo", - "details": null, - "created_at": "2023-03-13T09:39:13.321Z", - "updated_at": "2023-03-13T09:39:13.321Z" - } - ] - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "List all comments", - "parameters": [ - { - "schema": { - "type": "string", - "example": "10" - }, - "in": "query", - "name": "row_id", - "required": true, - "description": "Row ID" - }, - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "md_c6csq89tl37jm5" - }, - "in": "query", - "name": "fk_model_id", - "required": true, - "description": "Foreign Key to Model" - }, - { - "schema": { - "type": "boolean", - "example": true - }, - "in": "query", - "name": "comments_only", - "description": "Is showing comments only?" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["Utils"] - }, - "post": { - "summary": "Comment Rows", - "operationId": "utils-comment-row", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Audit" - }, - "examples": { - "Example 1": { - "value": { - "user": "w@nocodb.com", - "row_id": "1", - "fk_model_id": "md_5mipbdg6ketmv8", - "op_type": "COMMENT", - "description": "qq", - "project_id": "p_63b4q0qengen1x", - "id": "adt_vx58jpp0loo8qy" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CommentReq" - }, - "examples": { - "Example 1": { - "value": { - "description": "This is the comment for the row", - "fk_model_id": "md_ehn5izr99m7d45", - "row_id": "3" - } - } - } - } - } - }, - "tags": ["Utils"], - "description": "Create a new comment in a row. Logged in Audit.", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/audits/{auditId}/comment": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "adt_zlskd6rlf3liay" - }, - "name": "auditId", - "in": "path", - "required": true, - "description": "Audit ID" - }, - { - "name": "xc-auth", - "in": "header", - "required": false, - "schema": { - "type": "string" - }, - "description": "Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN." - } - ], - "patch": { - "summary": "Update Comment in Audit", - "operationId": "utils-comment-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number", - "example": 1 - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - } - }, - "tags": ["Utils"], - "description": "Update comment in Audit", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CommentUpdateReq" - }, - "examples": { - "Example 1": { - "value": { - "description": "This is the comment for the row" - } - } - } - } - } - } - } - }, - "/api/v1/db/meta/audits/comments/count": { - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "get": { - "summary": "Count Comments", - "operationId": "utils-comment-count", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "x-stoplight": { - "id": "ziwcy4va5r1ao" - }, - "type": "object", - "properties": { - "count": { - "type": "string", - "x-stoplight": { - "id": "5r91gkxmaiyv4" - }, - "description": "The number of comments", - "example": "4" - }, - "row_id": { - "type": "string", - "x-stoplight": { - "id": "08sgorhq172sm" - }, - "description": "Row ID", - "example": "1" - } - }, - "required": ["count", "row_id"] - } - }, - "examples": { - "Example 1": { - "value": [ - { - "count": "4", - "row_id": "1" - } - ] - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Return the number of comments in the given query.", - "parameters": [ - { - "in": "query", - "name": "ids", - "required": true, - "description": "Comment IDs" - }, - { - "schema": { - "$ref": "#/components/schemas/Id" - }, - "in": "query", - "name": "fk_model_id", - "required": true, - "description": "Foreign Key to Model" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["Utils"] - } - }, - "/api/v1/db/meta/projects/{projectId}/audits": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - } - ], - "get": { - "summary": "List Audits in Project", - "operationId": "project-audit-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "list": { - "type": "array", - "uniqueItems": true, - "minItems": 1, - "items": { - "$ref": "#/components/schemas/Audit" - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated" - } - }, - "required": ["list", "pageInfo"] - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "List all audit data in the given project", - "parameters": [ - { - "schema": { - "type": "integer", - "minimum": 0 - }, - "in": "query", - "name": "offset" - }, - { - "schema": { - "type": "integer", - "maximum": 1 - }, - "in": "query", - "name": "limit" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["Project"] - } - }, - "/api/v1/db/meta/audits/rows/{rowId}/update": { - "parameters": [ - { - "schema": { - "example": "1" - }, - "name": "rowId", - "in": "path", - "required": true, - "description": "Unique Row ID" - } - ], - "post": { - "summary": "Update Audit Row", - "operationId": "utils-audit-row-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Audit" - }, - "examples": { - "Example 1": { - "value": { - "user": "w@nocodb.com", - "row_id": "1", - "fk_model_id": "md_5mipbdg6ketmv8", - "op_type": "COMMENT", - "description": "Table Sheet-1 : field Column A got changed from foo to bar", - "project_id": "p_63b4q0qengen1x", - "id": "adt_vx58jpp0loo8qy" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Utils"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AuditRowUpdateReq" - }, - "examples": { - "Example 1": { - "value": { - "column_name": "baz", - "fk_model_id": "md_ehn5izr99m7d45", - "row_id": "1", - "prev_value": "foo", - "value": "bar" - } - } - } - } - } - }, - "description": "Update Audit Row", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/tables/{tableId}/hooks": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "md_w9gpnaousnfss1", - "type": "string" - }, - "name": "tableId", - "in": "path", - "required": true, - "description": "Unique Table ID" - } - ], - "get": { - "summary": "List Table Hooks", - "operationId": "db-table-webhook-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HookList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "active": 0, - "async": 0, - "description": "This is my hook description", - "env": "all", - "event": "after", - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "string", - "notification": "{\"type\":\"URL\",\"payload\":{\"method\":\"POST\",\"body\":\"{{ json data }}\",\"headers\":[{}],\"parameters\":[{}],\"auth\":\"\",\"path\":\"http://example.com\"}}", - "null": null, - "operation": "insert", - "retries": 10, - "retry_interval": 60000, - "timeout": 60000, - "title": "My Webhook" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "List all hook records in the given Table", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["DB Table Webhook"] - }, - "post": { - "summary": "Create Table Hook", - "operationId": "db-table-webhook-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Hook" - }, - "examples": { - "Example 1": { - "value": { - "active": 0, - "async": 0, - "description": "This is my hook description", - "env": "all", - "event": "after", - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "string", - "notification": "{\"type\":\"URL\",\"payload\":{\"method\":\"POST\",\"body\":\"{{ json data }}\",\"headers\":[{}],\"parameters\":[{}],\"auth\":\"\",\"path\":\"http://example.com\"}}", - "null": null, - "operation": "insert", - "retries": 10, - "retry_interval": 60000, - "timeout": 60000, - "title": "My Webhook" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Create a hook in the given table", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HookReq" - }, - "examples": { - "Example 1": { - "value": { - "active": 0, - "async": 0, - "description": "This is my hook description", - "env": "all", - "event": "after", - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "string", - "notification": "{\"type\":\"URL\",\"payload\":{\"method\":\"POST\",\"body\":\"{{ json data }}\",\"headers\":[{}],\"parameters\":[{}],\"auth\":\"\",\"path\":\"http://example.com\"}}", - "null": null, - "operation": "insert", - "retries": 10, - "retry_interval": 60000, - "timeout": 60000, - "title": "My Webhook", - "condition": false - } - } - } - } - } - }, - "tags": ["DB Table Webhook"] - } - }, - "/api/v1/db/meta/tables/{tableId}/hooks/test": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "md_w9gpnaousnfss1", - "type": "string" - }, - "name": "tableId", - "in": "path", - "required": true, - "description": "Unique Table ID" - } - ], - "post": { - "summary": "Test Hook", - "operationId": "db-table-webhook-test", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "l5k90tzuvvv1g" - }, - "example": "The hook has been tested successfully" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "The hook has been tested successfully" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Webhook"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HookTestReq" - }, - "examples": { - "Example 1": { - "value": { - "hook": { - "active": 0, - "async": 0, - "description": "This is my hook description", - "env": "all", - "event": "after", - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "string", - "notification": "{\"type\":\"URL\",\"payload\":{\"method\":\"POST\",\"body\":\"{{ json data }}\",\"headers\":[{}],\"parameters\":[{}],\"auth\":\"\",\"path\":\"http://example.com\"}}", - "null": null, - "operation": "insert", - "retries": 10, - "retry_interval": 60000, - "timeout": 60000, - "title": "My Webhook" - }, - "payload": { - "data": { - "Id": 1, - "Title": "Sample Text", - "CreatedAt": "2023-03-03T10:03:06.484Z", - "UpdatedAt": "2023-03-03T10:03:06.484Z", - "attachment": [ - { - "url": "https://nocodb.com/dummy.png", - "title": "image.png", - "mimetype": "image/png", - "size": 0 - } - ], - "f": "Sample Output" - } - } - } - } - } - } - } - }, - "description": "Test the hook in the given Table", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/tables/{tableId}/hooks/samplePayload/{operation}/{version}": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "md_w9gpnaousnfss1", - "type": "string" - }, - "name": "tableId", - "in": "path", - "required": true, - "description": "Unique Table ID" - }, - { - "schema": { - "type": "string", - "enum": [ - "insert", - "update", - "delete", - "bulkInsert", - "bulkUpdate", - "bulkDelete" - ] - }, - "name": "operation", - "in": "path", - "required": true, - "description": "Hook Operation" - }, - { - "schema": { - "type": "string", - "enum": ["v1", "v2"] - }, - "name": "version", - "in": "path", - "required": true, - "description": "Hook Version" - } - ], - "get": { - "summary": "Get Sample Hook Payload", - "operationId": "db-table-webhook-sample-payload-get", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "data": { - "type": "object", - "x-stoplight": { - "id": "qifsikf69hqbl" - }, - "description": "Sample Payload Data" - } - } - }, - "examples": { - "Example 1": { - "value": { - "data": { - "Id": 1, - "Title": "Sample Text", - "CreatedAt": "2023-03-13T04:59:49.363Z", - "UpdatedAt": "2023-03-13T04:59:49.363Z" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Get the sample hook payload", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["DB Table Webhook"] - } - }, - "/api/v1/db/meta/hooks/{hookId}": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "hk_0063k4o1frnxbr" - }, - "name": "hookId", - "in": "path", - "required": true, - "description": "Unique Hook ID" - } - ], - "patch": { - "summary": "Update Hook", - "operationId": "db-table-webhook-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Hook" - }, - "examples": { - "Example 1": { - "value": { - "active": 0, - "async": 0, - "description": "This is my hook description", - "env": "all", - "event": "after", - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "string", - "notification": "{\"type\":\"URL\",\"payload\":{\"method\":\"POST\",\"body\":\"{{ json data }}\",\"headers\":[{}],\"parameters\":[{}],\"auth\":\"\",\"path\":\"http://example.com\"}}", - "null": null, - "operation": "insert", - "retries": 10, - "retry_interval": 60000, - "timeout": 60000, - "title": "My Webhook" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Webhook"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Hook" - }, - "examples": { - "Example 1": { - "value": { - "active": 0, - "async": 0, - "description": "This is my hook description", - "env": "all", - "event": "after", - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "string", - "notification": "{\"type\":\"URL\",\"payload\":{\"method\":\"POST\",\"body\":\"{{ json data }}\",\"headers\":[{}],\"parameters\":[{}],\"auth\":\"\",\"path\":\"http://example.com\"}}", - "null": null, - "operation": "insert", - "retries": 10, - "retry_interval": 60000, - "timeout": 60000, - "title": "My Webhook" - } - } - } - } - } - }, - "description": "Update the exsiting hook by its ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "delete": { - "summary": "Delete Hook", - "operationId": "db-table-webhook-delete", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "boolean" - }, - "examples": { - "Example 1": { - "value": true - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Webhook"], - "description": "Delete the exsiting hook by its ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/plugins": { - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "get": { - "summary": "List Plugins", - "operationId": "plugin-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "list": { - "type": "array", - "uniqueItems": true, - "minItems": 1, - "items": { - "$ref": "#/components/schemas/Plugin" - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "List all plugins", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["Plugin"] - } - }, - "/api/v1/db/meta/plugins/{pluginTitle}/status": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "pluginTitle", - "in": "path", - "required": true, - "description": "Plugin Title" - } - ], - "get": { - "summary": "Get Plugin Status", - "operationId": "plugin-status", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "boolean" - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Check plugin is active or not", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["Plugin"], - "x-internal": false - } - }, - "/api/v1/db/meta/plugins/test": { - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "post": { - "summary": "Test Plugin", - "operationId": "plugin-test", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": {} - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Test if the plugin is working with the given configurations", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["Plugin"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PluginTestReq" - }, - "examples": { - "Example 1": { - "value": { - "title": "Plugin Foo", - "input": "{\"bucket\":\"my-bucket\",\"region\":\"us-west-004\",\"access_key\":\"redacted\",\"access_secret\":\"redacted\"}", - "category": "Email" - } - } - } - } - } - } - } - }, - "/api/v1/db/meta/plugins/{pluginId}": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "pluginId", - "in": "path", - "required": true, - "description": "Plugin ID" - } - ], - "patch": { - "summary": "Update Plugin", - "operationId": "plugin-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": {} - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Plugin"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PluginReq" - } - } - } - }, - "description": "Update the plugin data by ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "x-internal": false - }, - "get": { - "summary": "Get Plugin", - "operationId": "plugin-read", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Plugin" - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Plugin"], - "description": "Get the plugin data by ID", - "x-internal": false - } - }, - "/api/v1/db/meta/connection/test": { - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "post": { - "summary": "Test DB Connection", - "operationId": "utils-test-connection", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "code": { - "type": "number" - }, - "message": { - "type": "string" - }, - "data": { - "type": "object", - "x-stoplight": { - "id": "6orbk04w97ien" - } - } - } - }, - "examples": { - "Example 1": { - "value": { - "code": 0, - "message": "", - "data": {} - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Utils"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "x-examples": { - "Example 1": { - "client": "mysql2", - "connection": { - "host": "localhost", - "port": "3306", - "user": "root", - "password": "password", - "database": null - } - } - }, - "properties": { - "client": { - "description": "DB Type", - "enum": [ - "mssql", - "mysql", - "mysql2", - "oracledb", - "pg", - "snowflake", - "sqlite3" - ], - "example": "mysql2", - "type": "string" - }, - "connection": { - "type": "object", - "properties": { - "host": { - "type": "string" - }, - "port": { - "type": "string" - }, - "user": { - "type": "string" - }, - "password": { - "type": "string" - }, - "database": { - "$ref": "#/components/schemas/StringOrNull" - } - } - } - } - }, - "examples": { - "Example 1": { - "value": { - "client": "mysql2", - "connection": { - "host": "localhost", - "port": "3306", - "user": "root", - "password": "password", - "database": null - } - } - } - } - } - } - }, - "description": "Test the DB Connection", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/url_to_config": { - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "post": { - "summary": "Convert JDBC URL to Config", - "operationId": "utils-url-to-config", - "tags": ["Utils"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "url": { - "type": "string", - "x-stoplight": { - "id": "fgdbmcjjtkky5" - }, - "description": "JDBC URL", - "example": "jdbc:mysql://username:password@localhost:3306/sakila" - } - } - }, - "examples": { - "Example 1": { - "value": { - "url": "jdbc:mysql://username:password@localhost:3306/sakila" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "x-examples": { - "Example 1": { - "client": "mysql2", - "connection": { - "user": "username", - "password": "password", - "database": "sakila", - "host": "localhost", - "port": "3306" - } - } - }, - "properties": { - "client": { - "description": "DB Type", - "enum": [ - "mssql", - "mysql", - "mysql2", - "oracledb", - "pg", - "snowflake", - "sqlite3" - ], - "example": "mysql2", - "type": "string" - }, - "connection": { - "type": "object", - "description": "Connection Config", - "properties": { - "user": { - "type": "string", - "description": "DB User" - }, - "password": { - "type": "string", - "description": "DB Password" - }, - "database": { - "type": "string", - "description": "DB Name" - }, - "host": { - "type": "string", - "description": "DB Host" - }, - "port": { - "type": "string", - "description": "DB Host" - } - } - } - } - }, - "examples": { - "Example 1": { - "value": { - "client": "mysql2", - "connection": { - "user": "username", - "password": "password", - "database": "sakila", - "host": "localhost", - "port": "3306" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Extract XC URL From JDBC and parse to connection config", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/nocodb/info": { - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "get": { - "summary": "Get App Info", - "operationId": "utils-app-info", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "x-examples": { - "Example 1": { - "authType": "jwt", - "projectHasAdmin": true, - "firstUser": false, - "type": "rest", - "googleAuthEnabled": false, - "githubAuthEnabled": false, - "oneClick": false, - "connectToExternalDB": true, - "version": "0.105.3", - "defaultLimit": 25, - "ncMin": false, - "teleEnabled": false, - "auditEnabled": true, - "ncSiteUrl": "http://localhost:8080", - "ee": false, - "ncAttachmentFieldSize": 20971520, - "ncMaxAttachmentsAllowed": 10 - } - }, - "properties": { - "authType": { - "type": "string" - }, - "projectHasAdmin": { - "type": "boolean" - }, - "firstUser": { - "type": "boolean" - }, - "type": { - "type": "string" - }, - "googleAuthEnabled": { - "type": "boolean" - }, - "githubAuthEnabled": { - "type": "boolean" - }, - "oneClick": { - "type": "boolean" - }, - "connectToExternalDB": { - "type": "boolean" - }, - "version": { - "type": "string" - }, - "defaultLimit": { - "type": "number" - }, - "ncMin": { - "type": "boolean" - }, - "teleEnabled": { - "type": "boolean" - }, - "auditEnabled": { - "type": "boolean" - }, - "ncSiteUrl": { - "type": "string" - }, - "ee": { - "type": "boolean" - }, - "ncAttachmentFieldSize": { - "type": "number" - }, - "ncMaxAttachmentsAllowed": { - "type": "number" - }, - "isCloud": { - "type": "boolean", - "x-stoplight": { - "id": "bstdkpky2131f" - } - }, - "automationLogLevel": { - "type": "string", - "x-stoplight": { - "id": "uc3vaotye2eu8" - }, - "enum": ["OFF", "ERROR", "ALL"], - "example": "OFF" - } - } - }, - "examples": { - "Example 1": { - "value": { - "authType": "jwt", - "projectHasAdmin": true, - "firstUser": false, - "type": "rest", - "googleAuthEnabled": false, - "githubAuthEnabled": false, - "oneClick": false, - "connectToExternalDB": true, - "version": "0.105.3", - "defaultLimit": 25, - "ncMin": false, - "teleEnabled": false, - "auditEnabled": true, - "ncSiteUrl": "http://localhost:8080", - "ee": false, - "ncAttachmentFieldSize": 20971520, - "ncMaxAttachmentsAllowed": 10, - "isCloud": false, - "automationLogLevel": "OFF" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Utils"], - "description": "Get the application info such as authType, defaultLimit, version and etc.", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/axiosRequestMake": { - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "post": { - "summary": "Axios Request", - "operationId": "utils-axios-request-make", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {} - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Generic Axios Call", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object" - } - } - } - }, - "tags": ["Utils"], - "x-internal": true, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/version": { - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "get": { - "summary": "Get App Version", - "operationId": "utils-app-version", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "x-examples": { - "Example 1": { - "currentVersion": "0.105.3", - "releaseVersion": "0.105.3" - } - }, - "properties": { - "currentVersion": { - "type": "string", - "description": "Current NocoDB Version", - "example": "0.104.0" - }, - "releaseVersion": { - "type": "string", - "description": "Latest Release Version", - "example": "0.105.3" - } - } - }, - "examples": { - "Example 1": { - "value": { - "currentVersion": "0.104.0", - "releaseVersion": "0.105.3" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Utils"], - "description": "Get the application version", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/health": { - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "get": { - "summary": "Get Application Health Status", - "operationId": "utils-app-health", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "x-examples": { - "Example 1": { - "message": "OK", - "timestamp": 1678702175755, - "uptime": 1618.996877834 - } - }, - "properties": { - "message": { - "type": "string", - "example": "OK" - }, - "timestamp": { - "type": "string", - "example": "1678702175755" - }, - "uptime": { - "type": "string", - "example": "1618.996877834" - } - } - }, - "examples": { - "Example 1": { - "value": { - "message": "OK", - "timestamp": 1678702175755, - "uptime": 1618.996877834 - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Utils"], - "description": "Get Application Health Status", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/aggregated-meta-info": { - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "get": { - "summary": "Get Aggregated Meta Info", - "operationId": "utils-aggregated-meta-info", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "projectCount": { - "type": "integer" - }, - "projects": { - "type": "array", - "items": { - "type": "object", - "properties": { - "tableCount": { - "type": "object", - "properties": { - "table": { - "type": "integer", - "description": "Table Count" - }, - "view": { - "type": "integer", - "description": "View Count" - } - } - }, - "external": { - "type": "boolean", - "description": "External Project", - "default": false - }, - "viewCount": { - "type": "object", - "properties": { - "formCount": { - "type": "integer", - "description": "Form Count" - }, - "gridCount": { - "type": "integer", - "description": "Grid Count" - }, - "galleryCount": { - "type": "integer", - "description": "Gallery Count" - }, - "kanbanCount": { - "type": "integer", - "description": "Kanban Count" - }, - "total": { - "type": "integer", - "description": "Total View Count" - }, - "sharedFormCount": { - "type": "integer", - "description": "Shared Form Count" - }, - "sharedGridCount": { - "type": "integer", - "description": "Shared Grid Count" - }, - "sharedGalleryCount": { - "type": "integer", - "description": "Shared Gallery Count" - }, - "sharedKanbanCount": { - "type": "integer", - "description": "Shared Kanban Count" - }, - "sharedTotal": { - "type": "integer", - "description": "Shared Total View Count" - }, - "sharedLockedCount": { - "type": "integer", - "description": "Shared Locked View Count" - } - } - }, - "webhookCount": { - "type": "integer", - "description": "Webhook Count" - }, - "filterCount": { - "type": "integer", - "description": "Filter Count" - }, - "sortCount": { - "type": "integer", - "description": "Sort Count" - }, - "rowCount": { - "type": "array", - "items": { - "type": "object", - "properties": { - "TotalRecords": { - "type": "string" - } - } - }, - "description": "Row Count" - }, - "userCount": { - "type": "integer", - "description": "Total project user Count" - } - } - } - }, - "userCount": { - "type": "integer", - "description": "Total user Count" - }, - "sharedBaseCount": { - "type": "integer", - "description": "Total shared base Count" - } - }, - "x-examples": { - "Example 1": { - "projectCount": 1, - "projects": [ - { - "tableCount": { - "table": 3, - "view": 0 - }, - "external": false, - "viewCount": { - "formCount": 0, - "gridCount": 3, - "galleryCount": 0, - "kanbanCount": 0, - "total": 3, - "sharedFormCount": 0, - "sharedGridCount": 0, - "sharedGalleryCount": 0, - "sharedKanbanCount": 0, - "sharedTotal": 0, - "sharedLockedCount": 0 - }, - "webhookCount": 0, - "filterCount": 0, - "sortCount": 0, - "rowCount": [ - { - "TotalRecords": "76" - } - ], - "userCount": 1 - } - ], - "userCount": 1, - "sharedBaseCount": 0 - } - } - }, - "examples": { - "example-1": { - "value": { - "projectCount": 1, - "projects": [ - { - "tableCount": { - "table": 3, - "view": 0 - }, - "external": false, - "viewCount": { - "formCount": 0, - "gridCount": 3, - "galleryCount": 0, - "kanbanCount": 0, - "total": 3, - "sharedFormCount": 0, - "sharedGridCount": 0, - "sharedGalleryCount": 0, - "sharedKanbanCount": 0, - "sharedTotal": 0, - "sharedLockedCount": 0 - }, - "webhookCount": 0, - "filterCount": 0, - "sortCount": 0, - "rowCount": [ - { - "TotalRecords": "76" - } - ], - "userCount": 1 - } - ], - "userCount": 1, - "sharedBaseCount": 0 - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Utils"], - "description": "Get Aggregated Meta Info such as tableCount, dbViewCount, viewCount and etc.", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/cache": { - "get": { - "summary": "Get Cache", - "tags": ["Utils"], - "responses": {}, - "operationId": "utils-cache-get", - "description": "Get All K/V pairs in NocoCache", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "delete": { - "summary": "Delete Cache", - "operationId": "utils-cache-delete", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "boolean" - }, - "examples": { - "Example 1": { - "value": true - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Delete All K/V pairs in NocoCache", - "tags": ["Utils"], - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "/api/v1/db/meta/projects/{projectId}/api-tokens": { - "get": { - "summary": "List API Tokens in Project", - "tags": ["API Token"], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiTokenList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "id": "1", - "fk_user_id": "us_b3xo2i44nx5y9l", - "description": "This API Token is for ABC application", - "token": "DYh540o8hbWpUGdarekECKLdN5OhlgCUWutVJYX2" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "operationId": "api-token-list", - "description": "List API Tokens in the given project", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "post": { - "summary": "Create API Token", - "operationId": "api-token-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiToken" - }, - "examples": { - "Example 1": { - "value": { - "id": "1", - "fk_user_id": "us_b3xo2i44nx5y9l", - "description": "This API Token is for ABC application", - "token": "DYh540o8hbWpUGdarekECKLdN5OhlgCUWutVJYX2" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiTokenReq" - }, - "examples": { - "Example 1": { - "value": { - "description": "This API token is for ABC application" - } - } - } - } - }, - "description": "" - }, - "tags": ["API Token"], - "description": "Create API Token in a project", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - } - ] - }, - "/api/v1/db/meta/projects/{projectId}/api-tokens/{token}": { - "delete": { - "summary": "Delete API Token", - "operationId": "api-token-delete", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number", - "example": 1 - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["API Token"], - "description": "Delete the given API Token in project", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - }, - { - "schema": { - "type": "string", - "example": "DYh540o8hbWpUGdarekECKLdN5OhlgCUWutVJYX2" - }, - "name": "token", - "in": "path", - "required": true, - "description": "API Token" - } - ] - }, - "/api/v1/db/storage/upload": { - "post": { - "summary": "Attachment Upload", - "operationId": "storage-upload", - "responses": {}, - "tags": ["Storage"], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "$ref": "#/components/schemas/AttachmentReq" - }, - "examples": { - "Example 1": { - "value": { - "mimetype": "image/jpeg", - "path": "download/noco/jango_fett/Table1/attachment/uVbjPVQxC_SSfs8Ctx.jpg", - "size": 13052, - "title": "22bc-kavypmq4869759 (1).jpg" - } - } - } - } - }, - "description": "" - }, - "parameters": [ - { - "schema": { - "type": "string", - "example": "download/noco/jango_fett/Table1/attachment/uVbjPVQxC_SSfs8Ctx.jpg" - }, - "name": "path", - "in": "query", - "required": true, - "description": "Target File Path" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "description": "Upload attachment" - } - }, - "/api/v1/db/storage/upload-by-url": { - "post": { - "summary": "Attachment Upload by URL", - "operationId": "storage-upload-by-url", - "responses": {}, - "tags": ["Storage"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AttachmentReq" - } - }, - "examples": {} - } - } - }, - "parameters": [ - { - "schema": { - "type": "string", - "example": "download/noco/jango_fett/Table1/attachment/c7z_UF8sZBgJUxMjpN.jpg" - }, - "name": "path", - "in": "query", - "description": "Target File Path", - "required": true - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "description": "Upload attachment by URL. Used in Airtable Migration." - } - }, - "/api/v1/db/meta/projects/{projectId}/users/{userId}/resend-invite": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - }, - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "us_b3xo2i44nx5y9l" - }, - "name": "userId", - "in": "path", - "required": true, - "description": "Unique User ID" - } - ], - "post": { - "summary": "Resend User Invitation", - "operationId": "auth-project-user-resend-invite", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "m570oh5j3afjt" - }, - "description": "Success Message", - "example": "The invitation has been sent to the user" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "The invitation has been sent to the user" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Auth"], - "description": "Resend Invitation to a specific user", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - } - }, - "components": { - "schemas": { - "ApiToken": { - "description": "Model for API Token", - "examples": [ - { - "id": "1", - "fk_user_id": "us_b3xo2i44nx5y9l", - "description": "This API Token is for ABC application", - "token": "DYh540o8hbWpUGdarekECKLdN5OhlgCUWutVJYX2" - } - ], - "title": "API Token Model", - "type": "object", - "properties": { - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique API Token ID" - }, - "fk_user_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to User" - }, - "description": { - "type": "string", - "description": "API Token Description", - "example": "This API Token is for ABC application" - }, - "token": { - "type": "string", - "description": "API Token", - "example": "DYh540o8hbWpUGdarekECKLdN5OhlgCUWutVJYX2" - } - }, - "x-stoplight": { - "id": "95rfb0httdmw0" - } - }, - "ApiTokenReq": { - "description": "Model for API Token Request", - "examples": [ - { - "description": "This API token is for ABC application" - } - ], - "title": "API Token Request Model", - "type": "object", - "properties": { - "description": { - "description": "Description of the API token", - "maxLength": 255, - "type": "string", - "example": "This API Token is for ABC application" - } - }, - "x-stoplight": { - "id": "h3g2houpa6y9y" - } - }, - "ApiTokenList": { - "description": "Model for API Token List", - "x-stoplight": { - "id": "35b7cvjplxmfm" - }, - "examples": [ - { - "list": [ - { - "id": "1", - "fk_user_id": "us_b3xo2i44nx5y9l", - "description": "This API Token is for ABC application", - "token": "DYh540o8hbWpUGdarekECKLdN5OhlgCUWutVJYX2" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - ], - "title": "API Token List Model", - "type": "object", - "properties": { - "list": { - "type": "array", - "example": [ - { - "list": [ - { - "id": "1", - "fk_user_id": "us_b3xo2i44nx5y9l", - "description": "This API Token is for ABC application", - "token": "DYh540o8hbWpUGdarekECKLdN5OhlgCUWutVJYX2" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - ], - "x-stoplight": { - "id": "c7xu43yjgyjww" - }, - "description": "List of api token objects", - "items": { - "$ref": "#/components/schemas/ApiToken", - "x-stoplight": { - "id": "5ih4l0ix2tr5q" - } - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated", - "x-stoplight": { - "id": "0w8ktfnx3pusz" - }, - "description": "Model for Paginated" - } - }, - "required": ["list", "pageInfo"] - }, - "Attachment": { - "description": "Model for Attachment", - "examples": [ - { - "data": null, - "mimetype": "image/jpeg", - "path": "download/noco/jango_fett/Table1/attachment/c7z_UF8sZBgJUxMjpN.jpg", - "size": 12345, - "title": "kavypmq4869759.jpg" - } - ], - "title": "Attachment Model", - "type": "object", - "properties": { - "data": { - "description": "Data for uploading" - }, - "mimetype": { - "type": "string", - "description": "The mimetype of the attachment" - }, - "path": { - "type": "string", - "description": "File Path" - }, - "size": { - "type": "number", - "description": "Attachment Size" - }, - "title": { - "type": "string", - "description": "The title of the attachment. Used in UI." - }, - "url": { - "type": "string", - "description": "Attachment URL" - } - }, - "x-stoplight": { - "id": "pbx8hqgwdz7lw" - } - }, - "AttachmentReq": { - "description": "Model for Attachment Request", - "type": "object", - "x-examples": { - "Example 1": { - "mimetype": "image/jpeg", - "path": "download/noco/jango_fett/Table1/attachment/uVbjPVQxC_SSfs8Ctx.jpg", - "size": 13052, - "title": "22bc-kavypmq4869759 (1).jpg" - } - }, - "title": "Attachment Request Model", - "properties": { - "mimetype": { - "type": "string", - "description": "The mimetype of the attachment" - }, - "path": { - "type": "string", - "description": "The file path of the attachment" - }, - "size": { - "type": "number", - "description": "The size of the attachment" - }, - "title": { - "type": "string", - "description": "The title of the attachment used in UI" - }, - "url": { - "type": "string", - "description": "Attachment URL to be uploaded via upload-by-url" - } - }, - "x-stoplight": { - "id": "jmahtr8c5rw7f" - } - }, - "Audit": { - "description": "Model for Audit", - "examples": [ - { - "id": "adt_l5we7pkx70vaao", - "user": "w@nocodb.com", - "ip": "::ffff:127.0.0.1", - "base_id": "ds_3l9qx8xqksenrl", - "project_id": "p_9sx43moxhqtjm3", - "fk_model_id": "md_ehn5izr99m7d45", - "row_id": "rec0Adp9PMG9o7uJy", - "op_type": "AUTHENTICATION", - "op_sub_type": "UPDATE", - "status": "string", - "description": "Table nc_snms___Table_1 : field Date got changed from 2023-03-12 to ", - "details": "Date : 2023-03-12 " - } - ], - "title": "Audit Model", - "type": "object", - "properties": { - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "user": { - "type": "string", - "description": "The user name performing the action", - "example": "w@nocodb.com" - }, - "ip": { - "type": "string", - "example": "::ffff:127.0.0.1", - "description": "IP address from the user" - }, - "base_id": { - "type": "string", - "description": "Base ID in where action is performed", - "example": "ds_3l9qx8xqksenrl" - }, - "project_id": { - "type": "string", - "description": "Project ID in where action is performed", - "example": "p_9sx43moxhqtjm3" - }, - "fk_model_id": { - "type": "string", - "description": "Model ID in where action is performed", - "example": "md_ehn5izr99m7d45" - }, - "row_id": { - "type": "string", - "description": "Row ID", - "example": "rec0Adp9PMG9o7uJy" - }, - "op_type": { - "type": "string", - "description": "Operation Type", - "example": "AUTHENTICATION", - "enum": [ - "COMMENT", - "DATA", - "PROJECT", - "VIRTUAL_RELATION", - "RELATION", - "TABLE_VIEW", - "TABLE", - "VIEW", - "META", - "WEBHOOKS", - "AUTHENTICATION", - "TABLE_COLUMN", - "ORG_USER" - ] - }, - "op_sub_type": { - "type": "string", - "description": "Operation Sub Type", - "example": "UPDATE", - "enum": [ - "UPDATE", - "INSERT", - "BULK_INSERT", - "BULK_UPDATE", - "BULK_DELETE", - "LINK_RECORD", - "UNLINK_RECORD", - "DELETE", - "CREATE", - "RENAME", - "IMPORT_FROM_ZIP", - "EXPORT_TO_FS", - "EXPORT_TO_ZIP", - "SIGNIN", - "SIGNUP", - "PASSWORD_RESET", - "PASSWORD_FORGOT", - "PASSWORD_CHANGE", - "EMAIL_VERIFICATION", - "ROLES_MANAGEMENT", - "INVITE", - "RESEND_INVITE" - ] - }, - "status": { - "type": "string", - "description": "Audit Status" - }, - "description": { - "type": "string", - "description": "Description of the action", - "example": "Table nc_snms___Table_1 : field Date got changed from 2023-03-12 to " - }, - "details": { - "type": "string", - "description": "Detail", - "example": "Date : 2023-03-12 " - } - }, - "x-stoplight": { - "id": "i5ug0n7j1wub8" - } - }, - "AuditRowUpdateReq": { - "description": "Model for Audit Row Update Request", - "examples": [ - { - "column_name": "baz", - "fk_model_id": "md_ehn5izr99m7d45", - "row_id": "rec0Adp9PMG9o7uJy", - "prev_value": "foo", - "value": "bar" - } - ], - "title": "Audit Row Update Request Model", - "type": "object", - "properties": { - "column_name": { - "type": "string", - "description": "Column Name", - "example": "baz" - }, - "fk_model_id": { - "type": "string", - "description": "Foreign Key to Model", - "example": "md_ehn5izr99m7d45" - }, - "row_id": { - "type": "string", - "example": "rec0Adp9PMG9o7uJy", - "description": "Row ID" - }, - "prev_value": { - "description": "The previous value before the action" - }, - "value": { - "description": "The current value after the action" - } - }, - "x-stoplight": { - "id": "jcw57b1yv3xog" - } - }, - "Base": { - "description": "Model for Base", - "examples": [ - { - "alias": null, - "config": "", - "enabled": 1, - "id": "ds_krsappzu9f8vmo", - "inflection_column": "camelize", - "inflection_table": "camelize", - "is_meta": 1, - "meta": null, - "order": 1, - "project_id": "p_01clqvzik3izk6", - "type": "mysql2" - } - ], - "title": "Base Model", - "type": "object", - "properties": { - "alias": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Base Name - Default BASE will be null by default" - }, - "config": { - "description": "Base Configuration" - }, - "enabled": { - "$ref": "#/components/schemas/Bool", - "description": "Is this base enabled" - }, - "id": { - "description": "Unique Base ID", - "type": "string" - }, - "inflection_column": { - "description": "Inflection for columns", - "example": "camelize", - "type": "string" - }, - "inflection_table": { - "description": "Inflection for tables", - "example": "camelize", - "type": "string" - }, - "is_meta": { - "$ref": "#/components/schemas/Bool", - "description": "Is the data source connected externally" - }, - "order": { - "description": "The order of the list of bases", - "example": 1, - "type": "number" - }, - "project_id": { - "description": "The project ID that this base belongs to", - "type": "string" - }, - "type": { - "description": "DB Type", - "enum": [ - "mssql", - "mysql", - "mysql2", - "oracledb", - "pg", - "snowflake", - "sqlite3" - ], - "example": "mysql2", - "type": "string" - } - }, - "x-stoplight": { - "id": "9hy3cgp0r2c95" - } - }, - "BaseList": { - "description": "Model for Base List", - "examples": [ - { - "list": [ - { - "alias": null, - "config": "", - "enabled": 1, - "id": "ds_krsappzu9f8vmo", - "inflection_column": "camelize", - "inflection_table": "camelize", - "is_meta": 1, - "meta": null, - "order": 1, - "project_id": "p_01clqvzik3izk6", - "type": "mysql2" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - ], - "title": "Base List Model", - "type": "object", - "x-examples": { - "example-1": { - "bases": { - "list": [ - { - "alias": "sakila", - "config": "", - "created_at": "2023-03-02 11:28:17", - "enabled": 1, - "id": "ds_btbdt19zde0gj9", - "inflection_column": "camelize", - "inflection_table": "camelize", - "is_meta": null, - "meta": null, - "order": 2, - "project_id": "p_01clqvzik3izk6", - "type": "mysql2", - "updated_at": "2023-03-02 11:28:17" - }, - { - "alias": null, - "config": "", - "created_at": "2023-03-01 16:31:49", - "enabled": 1, - "id": "ds_krsappzu9f8vmo", - "inflection_column": "camelize", - "inflection_table": "camelize", - "is_meta": 1, - "meta": null, - "order": 1, - "project_id": "p_01clqvzik3izk6", - "type": "mysql2", - "updated_at": "2023-03-02 11:28:17" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 2, - "totalRows": 2 - } - } - } - }, - "properties": { - "list": { - "type": "array", - "x-stoplight": { - "id": "1q3ny60j1g4z2" - }, - "description": "List of base objects", - "items": { - "$ref": "#/components/schemas/Base", - "x-stoplight": { - "id": "udd0nrcv6pq8d" - } - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated", - "x-stoplight": { - "id": "xqwcniocq37hk" - }, - "description": "Paginated Info" - } - }, - "required": ["list", "pageInfo"], - "x-stoplight": { - "id": "kk8uqxeefumma" - } - }, - "BaseReq": { - "description": "Model for Base Request", - "examples": [ - { - "alias": "My Base", - "config": null, - "inflection_column": "camelize", - "inflection_table": "camelize", - "is_meta": true, - "type": "mysql" - } - ], - "properties": { - "alias": { - "description": "Base Name - Default BASE will be null by default", - "example": "My Base", - "maxLength": 128, - "type": "string" - }, - "config": { - "description": "Base Configuration" - }, - "inflection_column": { - "description": "Inflection for columns", - "example": "camelize", - "type": "string" - }, - "inflection_table": { - "description": "Inflection for tables", - "example": "camelize", - "type": "string" - }, - "is_meta": { - "description": "Is the data source connected externally", - "type": "boolean" - }, - "type": { - "description": "DB Type", - "enum": [ - "mssql", - "mysql", - "mysql2", - "oracledb", - "pg", - "snowflake", - "sqlite3" - ], - "type": "string" - } - }, - "title": "Base Request", - "type": "object", - "x-stoplight": { - "id": "j2z6ain3204zi" - } - }, - "Bool": { - "description": "Model for Bool", - "examples": [true], - "oneOf": [ - { - "description": "0 or 1", - "example": 0, - "type": "integer" - }, - { - "description": "true or false", - "type": "boolean" - }, - { - "type": "null" - } - ], - "title": "Bool Model", - "x-stoplight": { - "id": "8n3vnyr22sbvj" - } - }, - "Column": { - "description": "Model for Column", - "examples": [ - { - "ai": 0, - "au": 0, - "base_id": "ds_krsappzu9f8vmo", - "cc": "", - "cdf": null, - "clen": "45", - "column_name": "title", - "cop": "2", - "created_at": "2023-03-02 13:14:16", - "csn": "utf8mb4", - "ct": "varchar(45)", - "deleted": null, - "dt": "varchar", - "dtx": "specificType", - "dtxp": "45", - "dtxs": null, - "fk_model_id": "md_yvwvbt2i78rgcm", - "id": "cl_0j9gv0oi8vjy46", - "meta": null, - "np": null, - "ns": null, - "order": 2, - "pk": 0, - "project_id": "p_01clqvzik3izk6", - "pv": 1, - "rqd": 0, - "system": 0, - "title": "Title", - "uidt": "SingleLineText", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 13:14:16", - "validate": null, - "virtual": null - } - ], - "title": "Column Model", - "type": "object", - "properties": { - "ai": { - "$ref": "#/components/schemas/Bool", - "description": "Is Auto-Increment?" - }, - "au": { - "$ref": "#/components/schemas/Bool", - "description": "Auto Update Timestamp" - }, - "base_id": { - "description": "Base ID that this column belongs to", - "example": "ds_krsappzu9f8vmo", - "type": "string" - }, - "cc": { - "description": "Column Comment", - "type": "string" - }, - "cdf": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Column Default" - }, - "clen": { - "description": "Character Maximum Length", - "oneOf": [ - { - "type": "integer" - }, - { - "type": "null" - }, - { - "type": "string" - } - ] - }, - "colOptions": { - "anyOf": [ - { - "$ref": "#/components/schemas/Formula" - }, - { - "$ref": "#/components/schemas/LinkToAnotherRecord" - }, - { - "$ref": "#/components/schemas/Lookup" - }, - { - "$ref": "#/components/schemas/Rollup" - }, - { - "$ref": "#/components/schemas/SelectOptions" - }, - { - "type": "object" - } - ], - "description": "Column Options" - }, - "column_name": { - "description": "Column Name", - "example": "title", - "type": "string" - }, - "cop": { - "description": "Column Ordinal Position", - "type": "string" - }, - "csn": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Character Set Name" - }, - "ct": { - "description": "Column Type", - "example": "varchar(45)", - "type": "string" - }, - "deleted": { - "$ref": "#/components/schemas/Bool", - "description": "Is Deleted?" - }, - "dt": { - "description": "Data Type in DB", - "example": "varchar", - "type": "string" - }, - "dtx": { - "description": "Data Type X", - "example": "specificType", - "type": "string" - }, - "dtxp": { - "description": "Data Type X Precision", - "oneOf": [ - { - "type": "null" - }, - { - "type": "number" - }, - { - "type": "string" - } - ] - }, - "dtxs": { - "description": "Data Type X Scale", - "oneOf": [ - { - "type": "null" - }, - { - "type": "number" - }, - { - "type": "string" - } - ] - }, - "fk_model_id": { - "description": "Model ID that this column belongs to", - "example": "md_yvwvbt2i78rgcm", - "type": "string" - }, - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "description": "Meta Info" - }, - "np": { - "description": "Numeric Precision", - "oneOf": [ - { - "type": "integer" - }, - { - "type": "null" - }, - { - "type": "string" - } - ] - }, - "ns": { - "description": "Numeric Scale", - "oneOf": [ - { - "type": "integer" - }, - { - "type": "null" - }, - { - "type": "string" - } - ] - }, - "order": { - "description": "The order of the list of columns", - "type": "number" - }, - "pk": { - "$ref": "#/components/schemas/Bool", - "description": "Is Primary Key?" - }, - "pv": { - "$ref": "#/components/schemas/Bool", - "description": "Is Primary Value?" - }, - "rqd": { - "$ref": "#/components/schemas/Bool", - "description": "Is Required?" - }, - "system": { - "$ref": "#/components/schemas/Bool", - "description": "Is System Column?" - }, - "title": { - "description": "Column Title", - "example": "Title", - "type": "string" - }, - "uidt": { - "description": "The data type in UI", - "example": "SingleLineText", - "enum": [ - "Attachment", - "AutoNumber", - "Barcode", - "Button", - "Checkbox", - "Collaborator", - "Count", - "CreateTime", - "Currency", - "Date", - "DateTime", - "Decimal", - "Duration", - "Email", - "Formula", - "ForeignKey", - "GeoData", - "Geometry", - "ID", - "JSON", - "LastModifiedTime", - "LongText", - "LinkToAnotherRecord", - "Lookup", - "MultiSelect", - "Number", - "Percent", - "PhoneNumber", - "Rating", - "Rollup", - "SingleLineText", - "SingleSelect", - "SpecificDBType", - "Time", - "URL", - "Year", - "QrCode" - ], - "type": "string" - }, - "un": { - "$ref": "#/components/schemas/Bool", - "description": "Is Unsigned?" - }, - "unique": { - "$ref": "#/components/schemas/Bool", - "description": "Is unique?" - }, - "visible": { - "$ref": "#/components/schemas/Bool", - "description": "Is Visible?" - } - }, - "x-stoplight": { - "id": "3a4lsn477mx4e" - } - }, - "ColumnList": { - "description": "Model for Column List", - "examples": [ - { - "list": [ - { - "ai": 0, - "au": 0, - "base_id": "ds_krsappzu9f8vmo", - "cc": "", - "cdf": null, - "clen": "45", - "column_name": "title", - "cop": "2", - "created_at": "2023-03-02 13:14:16", - "csn": "utf8mb4", - "ct": "varchar(45)", - "deleted": null, - "dt": "varchar", - "dtx": "specificType", - "dtxp": "45", - "dtxs": null, - "fk_model_id": "md_yvwvbt2i78rgcm", - "id": "cl_0j9gv0oi8vjy46", - "meta": null, - "np": null, - "ns": null, - "order": 2, - "pk": 0, - "project_id": "p_01clqvzik3izk6", - "pv": 1, - "rqd": 0, - "system": 0, - "title": "Title", - "uidt": "SingleLineText", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 13:14:16", - "validate": null, - "virtual": null - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - ], - "title": "Column List Model", - "type": "object", - "x-examples": { - "example-1": { - "bases": { - "list": [ - { - "alias": "string", - "database": "string", - "host": "string", - "id": "string", - "params": "string", - "password": "string", - "port": 0, - "project_id": "string", - "ssl": "string", - "type": "string", - "url": "string", - "username": "string" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "pageSize": 0, - "sort": "string", - "totalRows": 0 - } - } - } - }, - "properties": { - "list": { - "type": "array", - "x-stoplight": { - "id": "c6lpw8px25356" - }, - "description": "List of column objects", - "items": { - "$ref": "#/components/schemas/Column", - "x-stoplight": { - "id": "zbm89i86dr73y" - } - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated", - "x-stoplight": { - "id": "ko0s0z13h4hsw" - } - } - }, - "required": ["list", "pageInfo"], - "x-stoplight": { - "id": "rldg44w1alasg" - } - }, - "ColumnReq": { - "allOf": [ - { - "anyOf": [ - { - "$ref": "#/components/schemas/FormulaColumnReq" - }, - { - "$ref": "#/components/schemas/LinkToAnotherColumnReq" - }, - { - "$ref": "#/components/schemas/LookupColumnReq" - }, - { - "$ref": "#/components/schemas/NormalColumnRequest" - }, - { - "$ref": "#/components/schemas/RollupColumnReq" - } - ] - }, - { - "properties": { - "column_name": { - "type": "string" - }, - "column_order": { - "description": "Column order in a specific view", - "properties": { - "order": { - "type": "number" - }, - "view_id": { - "type": "string" - } - }, - "type": "object" - }, - "title": { - "maxLength": 255, - "minLength": 1, - "type": "string" - } - }, - "required": ["title"] - } - ], - "description": "Model for Column Request", - "examples": [ - { - "ai": 0, - "au": 0, - "base_id": "ds_krsappzu9f8vmo", - "cc": "", - "cdf": null, - "clen": "45", - "column_name": "title", - "cop": "2", - "created_at": "2023-03-02 13:14:16", - "csn": "utf8mb4", - "ct": "varchar(45)", - "deleted": null, - "dt": "varchar", - "dtx": "specificType", - "dtxp": "45", - "dtxs": null, - "fk_model_id": "md_yvwvbt2i78rgcm", - "id": "cl_0j9gv0oi8vjy46", - "meta": null, - "np": null, - "ns": null, - "order": 2, - "pk": 0, - "project_id": "p_01clqvzik3izk6", - "pv": 1, - "rqd": 0, - "system": 0, - "title": "Title", - "uidt": "SingleLineText", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 13:14:16", - "validate": null, - "virtual": null - } - ], - "title": "Column Request Model", - "type": "object", - "x-stoplight": { - "id": "dvbn9dnme6jgi" - } - }, - "CommentReq": { - "description": "Model for Comment Request", - "examples": [ - { - "description": "This is the comment for the row", - "fk_model_id": "md_ehn5izr99m7d45", - "row_id": "3" - } - ], - "title": "Comment Request Model", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Description for the target row", - "example": "This is the comment for the row" - }, - "fk_model_id": { - "type": "string", - "description": "Foreign Key to Model", - "example": "md_ehn5izr99m7d45" - }, - "row_id": { - "type": "string", - "description": "Row ID", - "example": "3" - } - }, - "required": ["fk_model_id", "row_id"], - "x-stoplight": { - "id": "7nwlyinuliuvy" - } - }, - "CommentUpdateReq": { - "description": "Model for Comment Update Request", - "x-stoplight": { - "id": "r0f3ng2rahe38" - }, - "examples": [ - { - "description": "This is the comment for the row" - } - ], - "title": "Comment Update Request Model", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Description for the target row", - "example": "This is the comment for the row" - } - } - }, - "Filter": { - "description": "Model for Filter", - "examples": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "comparison_op": "eq", - "comparison_sub_op": null, - "created_at": "2023-03-02 18:18:05", - "fk_column_id": "cl_d7ah9n2qfupgys", - "fk_hook_id": null, - "fk_parent_id": null, - "fk_view_id": "vw_b739e29vqmrxnf", - "id": "fi_xn647tpmdq8fu8", - "is_group": null, - "logical_op": "and", - "order": 1, - "project_id": "p_xm3thidrblw4n7", - "updated_at": "2023-03-02 18:18:05", - "value": "foo" - } - ], - "properties": { - "base_id": { - "description": "Unqiue Base ID", - "readOnly": true, - "type": "string" - }, - "children": { - "description": "Children filters. Available when the filter is grouped.", - "items": { - "$ref": "#/components/schemas/Filter" - }, - "type": "array" - }, - "comparison_op": { - "description": "Comparison Operator", - "enum": [ - "allof", - "anyof", - "blank", - "btw", - "checked", - "empty", - "eq", - "ge", - "gt", - "gte", - "in", - "is", - "isWithin", - "isnot", - "le", - "like", - "lt", - "lte", - "nallof", - "nanyof", - "nbtw", - "neq", - "nlike", - "not", - "notblank", - "notchecked", - "notempty", - "notnull", - "null" - ], - "type": "string" - }, - "comparison_sub_op": { - "anyOf": [ - { - "enum": [ - "daysAgo", - "daysFromNow", - "exactDate", - "nextMonth", - "nextNumberOfDays", - "nextWeek", - "nextYear", - "oneMonthAgo", - "oneMonthFromNow", - "oneWeekAgo", - "oneWeekFromNow", - "pastMonth", - "pastNumberOfDays", - "pastWeek", - "pastYear", - "today", - "tomorrow", - "yesterday" - ], - "type": "string" - }, - { - "type": "null" - } - ], - "description": "Comparison Sub-Operator" - }, - "fk_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Column" - }, - "fk_hook_id": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Foreign Key to Hook" - }, - "fk_model_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Model" - }, - "fk_parent_id": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Foreign Key to parent group." - }, - "fk_view_id": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Foreign Key to View" - }, - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "is_group": { - "description": "Is this filter grouped?", - "oneOf": [ - { - "type": "boolean" - }, - { - "type": "integer" - }, - { - "type": "null" - } - ] - }, - "logical_op": { - "description": "Logical Operator", - "enum": ["and", "not", "or"], - "type": "string" - }, - "project_id": { - "description": "Unique Project ID", - "readOnly": true, - "type": "string" - }, - "value": { - "description": "The filter value. Can be NULL for some operators." - } - }, - "readOnly": true, - "title": "Filter Model", - "type": "object", - "x-stoplight": { - "id": "f8vsb8alix01i" - } - }, - "FilterList": { - "description": "Model for Filter List", - "examples": [ - { - "list": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "comparison_op": "eq", - "comparison_sub_op": null, - "created_at": "2023-03-02 18:18:05", - "fk_column_id": "cl_d7ah9n2qfupgys", - "fk_hook_id": null, - "fk_parent_id": null, - "fk_view_id": "vw_b739e29vqmrxnf", - "id": "fi_xn647tpmdq8fu8", - "is_group": null, - "logical_op": "and", - "order": 1, - "project_id": "p_xm3thidrblw4n7", - "updated_at": "2023-03-02 18:18:05", - "value": "foo" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - ], - "title": "Filter List Model", - "type": "object", - "x-examples": { - "example-1": { - "bases": { - "list": [ - { - "alias": "string", - "database": "string", - "host": "string", - "id": "string", - "params": "string", - "password": "string", - "port": 0, - "project_id": "string", - "ssl": "string", - "type": "string", - "url": "string", - "username": "string" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "pageSize": 0, - "sort": "string", - "totalRows": 0 - } - } - } - }, - "properties": { - "list": { - "type": "array", - "x-stoplight": { - "id": "22sgv37ve9kxo" - }, - "description": "List of filter objects", - "items": { - "$ref": "#/components/schemas/Filter", - "x-stoplight": { - "id": "ttw5rxhy83k8p" - } - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated", - "x-stoplight": { - "id": "7cyrb1770mrzz" - } - } - }, - "required": ["list", "pageInfo"], - "x-stoplight": { - "id": "mfxg43iomcoue" - } - }, - "FilterLogList": { - "description": "Model for Filter Log List", - "x-stoplight": { - "id": "0voe9zdizy5qd" - }, - "examples": [ - { - "list": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "comparison_op": "eq", - "comparison_sub_op": null, - "created_at": "2023-03-02 18:18:05", - "fk_column_id": "cl_d7ah9n2qfupgys", - "fk_hook_id": null, - "fk_parent_id": null, - "fk_view_id": "vw_b739e29vqmrxnf", - "id": "fi_xn647tpmdq8fu8", - "is_group": null, - "logical_op": "and", - "order": 1, - "project_id": "p_xm3thidrblw4n7", - "updated_at": "2023-03-02 18:18:05", - "value": "foo" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - ], - "title": "Filter Log List Model", - "type": "object", - "x-examples": { - "example-1": { - "bases": { - "list": [ - { - "alias": "string", - "database": "string", - "host": "string", - "id": "string", - "params": "string", - "password": "string", - "port": 0, - "project_id": "string", - "ssl": "string", - "type": "string", - "url": "string", - "username": "string" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "pageSize": 0, - "sort": "string", - "totalRows": 0 - } - } - } - }, - "properties": { - "list": { - "type": "array", - "x-stoplight": { - "id": "22sgv37ve9kxo" - }, - "description": "List of filter objects", - "items": { - "$ref": "#/components/schemas/Filter", - "x-stoplight": { - "id": "ttw5rxhy83k8p" - } - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated", - "x-stoplight": { - "id": "7cyrb1770mrzz" - } - } - }, - "required": ["list", "pageInfo"] - }, - "FilterReq": { - "description": "Model for Filter Request", - "examples": [ - { - "comparison_op": "eq", - "comparison_sub_op": null, - "fk_column_id": "cl_d7ah9n2qfupgys", - "is_group": false, - "logical_op": "and", - "value": "foo" - } - ], - "title": "Filter Request Model", - "type": "object", - "x-stoplight": { - "id": "pugjn1hobswqf" - }, - "properties": { - "comparison_op": { - "description": "Comparison Operator", - "enum": [ - "allof", - "anyof", - "blank", - "btw", - "checked", - "empty", - "eq", - "ge", - "gt", - "gte", - "in", - "is", - "isWithin", - "isnot", - "le", - "like", - "lt", - "lte", - "nallof", - "nanyof", - "nbtw", - "neq", - "nlike", - "not", - "notblank", - "notchecked", - "notempty", - "notnull", - "null" - ], - "type": "string" - }, - "comparison_sub_op": { - "anyOf": [ - { - "enum": [ - "daysAgo", - "daysFromNow", - "exactDate", - "nextMonth", - "nextNumberOfDays", - "nextWeek", - "nextYear", - "oneMonthAgo", - "oneMonthFromNow", - "oneWeekAgo", - "oneWeekFromNow", - "pastMonth", - "pastNumberOfDays", - "pastWeek", - "pastYear", - "today", - "tomorrow", - "yesterday" - ], - "type": "string" - }, - { - "type": "null" - } - ], - "description": "Comparison Sub-Operator" - }, - "fk_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Column" - }, - "fk_parent_id": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Belong to which filter ID" - }, - "is_group": { - "$ref": "#/components/schemas/Bool", - "description": "Is this filter grouped?" - }, - "logical_op": { - "description": "Logical Operator", - "enum": ["and", "not", "or"], - "type": "string" - }, - "value": { - "description": "The filter value. Can be NULL for some operators." - } - }, - "readOnly": true - }, - "Form": { - "description": "Model for Form", - "examples": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "banner_image_url": null, - "columns": [ - { - "id": "fvc_ugj9zo5bzocxtl", - "base_id": "ds_g4ccx6e77h1dmi", - "project_id": "p_xm3thidrblw4n7", - "fk_view_id": "vw_kdf5cr7qmhksek", - "fk_column_id": "cl_phvuuwjrzcdo0g", - "uuid": null, - "label": null, - "help": null, - "description": null, - "required": null, - "show": 0, - "order": 1, - "created_at": "2023-03-04 16:40:47", - "updated_at": "2023-03-04 16:40:47", - "meta": {} - } - ], - "email": "user@example.com", - "fk_model_id": "md_rsu68aqjsbyqtl", - "heading": "My Form", - "lock_type": "collaborative", - "logo_url": null, - "meta": null, - "redirect_after_secs": null, - "redirect_url": null, - "show_blank_form": 0, - "subheading": "My Form Subheading", - "submit_another_form": 0, - "success_msg": "Thank you for the submission.", - "title": "Form View 1" - } - ], - "title": "Form Model", - "type": "object", - "properties": { - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID", - "x-stoplight": { - "id": "z6wjvs00d3qfk" - } - }, - "banner_image_url": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Banner Image URL. Not in use currently." - }, - "columns": { - "type": "array", - "description": "Form Columns", - "items": { - "$ref": "#/components/schemas/FormColumn" - } - }, - "email": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Email to sned after form is submitted" - }, - "fk_model_id": { - "type": "string", - "description": "Foreign Key to Model", - "example": "md_rsu68aqjsbyqtl" - }, - "base_id": { - "type": "string", - "description": "Base ID", - "example": "md_rsu68aqjsbyqtl", - "x-stoplight": { - "id": "kfz7tve8nzj6f" - } - }, - "heading": { - "type": "string", - "description": "The heading of the form", - "example": "My Form" - }, - "lock_type": { - "enum": ["collaborative", "locked", "personal"], - "type": "string", - "description": "Lock Type of this view", - "example": "collaborative" - }, - "logo_url": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Logo URL. Not in use currently." - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "description": "Meta Info for this view" - }, - "redirect_after_secs": { - "$ref": "#/components/schemas/StringOrNull", - "description": "The numbers of seconds to redirect after form submission" - }, - "redirect_url": { - "$ref": "#/components/schemas/StringOrNull", - "description": "URL to redirect after submission" - }, - "show_blank_form": { - "$ref": "#/components/schemas/Bool", - "description": "Show `Blank Form` after 5 seconds" - }, - "subheading": { - "type": "string", - "description": "The subheading of the form", - "example": "My Form Subheading" - }, - "submit_another_form": { - "$ref": "#/components/schemas/Bool", - "description": "Show `Submit Another Form` button" - }, - "success_msg": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Custom message after the form is successfully submitted" - }, - "title": { - "type": "string", - "description": "Form View Title", - "example": "Form View 1" - } - }, - "x-stoplight": { - "id": "918aga51qb7w1" - } - }, - "FormUpdateReq": { - "description": "Model for Form Update Request", - "examples": [ - { - "banner_image_url": null, - "email": "user@example.com", - "heading": "My Form", - "logo_url": null, - "meta": null, - "redirect_after_secs": null, - "redirect_url": null, - "show_blank_form": 0, - "subheading": "My Form Subheading", - "submit_another_form": 0, - "success_msg": "Thank you for the submission." - } - ], - "title": "Form Update Request Model", - "type": "object", - "properties": { - "banner_image_url": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Banner Image URL. Not in use currently." - }, - "email": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Email to sned after form is submitted" - }, - "heading": { - "description": "The heading of the form", - "example": "My Form", - "maxLength": 255, - "type": "string" - }, - "logo_url": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Logo URL. Not in use currently." - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "description": "Meta Info for this view" - }, - "redirect_after_secs": { - "$ref": "#/components/schemas/StringOrNull", - "description": "The numbers of seconds to redirect after form submission" - }, - "redirect_url": { - "$ref": "#/components/schemas/StringOrNull", - "description": "URL to redirect after submission" - }, - "show_blank_form": { - "$ref": "#/components/schemas/Bool", - "description": "Show `Blank Form` after 5 seconds" - }, - "subheading": { - "$ref": "#/components/schemas/StringOrNull", - "description": "The subheading of the form" - }, - "submit_another_form": { - "$ref": "#/components/schemas/Bool", - "description": "Show `Submit Another Form` button" - }, - "success_msg": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Custom message after the form is successfully submitted" - } - }, - "x-stoplight": { - "id": "zn4juts75pksq" - } - }, - "FormColumn": { - "description": "Model for Form Column", - "examples": [ - { - "id": "fvc_1m9b0aub791d4m", - "description": null, - "fk_column_id": "cl_ah9zavkn25ihyd", - "fk_view_id": "vw_6fqln9vdytdv8q", - "help": "This is a help text", - "label": "Form Label", - "meta": null, - "order": 1, - "required": 0, - "show": 0, - "uuid": null - } - ], - "title": "Form Column Model", - "type": "object", - "x-examples": { - "example-1": { - "_cn": "first_name", - "alias": "first_name", - "created_at": "2022-02-15 12:39:04", - "description": "dsdsdsdsd", - "fk_column_id": "cl_yvyhsl9u81tokc", - "fk_view_id": "vw_s1pf4umdnikoyn", - "help": null, - "id": "fvc_8z1i7t8aswkqxx", - "label": "dsdsds", - "order": 1, - "required": false, - "show": 1, - "enable_scanner": true, - "updated_at": "2022-02-15 12:39:16", - "uuid": null - } - }, - "properties": { - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "description": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Form Column Description (Not in use)" - }, - "fk_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Column" - }, - "fk_view_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to View" - }, - "help": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Form Column Help Text" - }, - "label": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Form Column Label" - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "description": "Meta Info" - }, - "order": { - "type": "number", - "description": "The order among all the columns in the form", - "example": 1 - }, - "required": { - "$ref": "#/components/schemas/Bool", - "description": "Is this form column required in submission?" - }, - "show": { - "$ref": "#/components/schemas/Bool", - "description": "Is this column shown in Form?" - }, - "enable_scanner": { - "$ref": "#/components/schemas/Bool", - "description": "Indicates whether the 'Fill by scan' button is visible for this column or not.", - "example": true - }, - "uuid": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Form Column UUID (Not in use)" - } - }, - "x-stoplight": { - "id": "gm46pinkspvrz" - } - }, - "FormColumnReq": { - "description": "Model for Form Column Request", - "examples": [ - { - "description": null, - "help": "This is a help text", - "label": "Form Label", - "meta": null, - "order": 1, - "required": 0, - "show": 0 - } - ], - "title": "Form Column Request Model", - "type": "object", - "x-examples": { - "example-1": { - "_cn": "first_name", - "alias": "first_name", - "created_at": "2022-02-15 12:39:04", - "description": "dsdsdsdsd", - "fk_column_id": "cl_yvyhsl9u81tokc", - "fk_view_id": "vw_s1pf4umdnikoyn", - "help": null, - "id": "fvc_8z1i7t8aswkqxx", - "label": "dsdsds", - "order": 1, - "required": false, - "show": 1, - "updated_at": "2022-02-15 12:39:16", - "uuid": null - } - }, - "properties": { - "description": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Form Column Description (Not in use)" - }, - "help": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Form Column Help Text" - }, - "label": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Form Column Label" - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "description": "Meta Info" - }, - "order": { - "type": "number", - "description": "The order among all the columns in the form" - }, - "required": { - "$ref": "#/components/schemas/Bool", - "description": "Is this form column required in submission?" - }, - "show": { - "$ref": "#/components/schemas/Bool", - "description": "Is this column shown in Form?" - } - }, - "x-stoplight": { - "id": "nmffmb1p3wkg9" - } - }, - "Formula": { - "description": "Model for Formula", - "examples": [ - { - "id": "fm_1lo8wqtvvipdns", - "fk_column_id": "cl_h2micb4jdnmsh1", - "formula": "CONCAT(\"FOO\", {{cl_c5knoi4xs4sfpt}})", - "formula_raw": "CONCAT(\"FOO\", {Title})", - "error": "Error Message shows here" - } - ], - "title": "Formula Model", - "type": "object", - "properties": { - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "fk_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Column" - }, - "formula": { - "type": "string", - "description": "Formula with column ID replaced", - "example": "CONCAT(\"FOO\", {{cl_c5knoi4xs4sfpt}})" - }, - "formula_raw": { - "type": "string", - "description": "Original Formula inputted in UI", - "example": "CONCAT(\"FOO\", {Title})" - }, - "error": { - "type": "string", - "description": "Error Message" - } - }, - "x-stoplight": { - "id": "hlu7yokpavxwb" - } - }, - "FormulaColumnReq": { - "description": "Model for Formula Column Request", - "examples": [ - { - "formula": "CONCAT(\"FOO\", {{cl_c5knoi4xs4sfpt}})", - "formula_raw": "CONCAT(\"FOO\", {Title})", - "title": "Formula", - "uidt": "Formula" - } - ], - "title": "Formula Column Request Model", - "type": "object", - "properties": { - "formula": { - "type": "string", - "description": "Formula with column ID replaced" - }, - "formula_raw": { - "type": "string", - "description": "Original Formula inputted in UI" - }, - "title": { - "maxLength": 255, - "minLength": 1, - "type": "string", - "description": "Formula Title" - }, - "uidt": { - "enum": ["Formula"], - "type": "string", - "description": "UI Data Type" - } - }, - "x-stoplight": { - "id": "v26r0c9hlimtv" - } - }, - "Gallery": { - "description": "Model for Gallery", - "examples": [ - { - "alias": "string", - "columns": [ - { - "fk_col_id": "string", - "fk_gallery_id": "string", - "help": "string", - "id": "string", - "label": "string" - } - ], - "cover_image": "string", - "cover_image_idx": 0, - "deleted": true, - "fk_cover_image_col_id": "string", - "fk_model_id": "string", - "fk_view_id": "string", - "lock_type": "collaborative", - "next_enabled": true, - "order": 0, - "prev_enabled": true, - "restrict_number": "string", - "restrict_size": "string", - "restrict_types": "string", - "title": "string" - } - ], - "properties": { - "alias": { - "type": "string" - }, - "columns": { - "items": { - "$ref": "#/components/schemas/GalleryColumn" - }, - "type": "array" - }, - "cover_image": { - "type": "string" - }, - "cover_image_idx": { - "type": "integer" - }, - "deleted": { - "$ref": "#/components/schemas/Bool" - }, - "fk_cover_image_col_id": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Foreign Key to Cover Image Column" - }, - "fk_model_id": { - "type": "string", - "description": "Foreign Key to Model" - }, - "fk_view_id": { - "type": "string", - "description": "Foreign Key to View" - }, - "lock_type": { - "enum": ["collaborative", "locked", "personal"], - "type": "string" - }, - "next_enabled": { - "$ref": "#/components/schemas/Bool" - }, - "order": { - "type": "number", - "description": "Order of Gallery" - }, - "prev_enabled": { - "$ref": "#/components/schemas/Bool" - }, - "restrict_number": { - "type": "string" - }, - "restrict_size": { - "type": "string" - }, - "restrict_types": { - "type": "string" - }, - "title": { - "type": "string" - } - }, - "title": "Gallery Model", - "type": "object", - "x-stoplight": { - "id": "i0h7av37o4eks" - } - }, - "GalleryColumn": { - "description": "Model for Gallery Column", - "examples": [ - { - "fk_col_id": "string", - "fk_gallery_id": "string", - "help": "string", - "id": "string", - "label": "string" - } - ], - "properties": { - "fk_col_id": { - "type": "string" - }, - "fk_gallery_id": { - "type": "string" - }, - "help": { - "type": "string" - }, - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "label": { - "type": "string" - } - }, - "title": "Gallery Column Model", - "type": "object", - "x-stoplight": { - "id": "jdhvl7gb33fqo" - } - }, - "GalleryUpdateReq": { - "description": "Model for Gallery View Update Request", - "x-stoplight": { - "id": "x57k1fq4101e1" - }, - "examples": [ - { - "fk_cover_image_col_id": "cl_ib8l4j1kiu1efx", - "meta": null - } - ], - "title": "Gallery View Update Request Model", - "type": "object", - "properties": { - "fk_cover_image_col_id": { - "$ref": "#/components/schemas/StringOrNull", - "description": "The id of the column that contains the cover image" - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "x-stoplight": { - "id": "zhp6jkrr54wuf" - }, - "description": "Meta Info" - } - } - }, - "GeoLocation": { - "description": "Model for Geo Location", - "examples": [ - { - "latitude": 18.52139, - "longitude": 179.87295 - } - ], - "properties": { - "latitude": { - "description": "The latitude of the location", - "example": 18.52139, - "exclusiveMaximum": 90, - "exclusiveMinimum": -90, - "format": "double", - "type": "number" - }, - "longitude": { - "description": "The longitude of the location", - "example": 179.87295, - "exclusiveMaximum": 180, - "exclusiveMinimum": -180, - "format": "double", - "type": "number" - } - }, - "title": "Geo Location Model", - "type": "object", - "x-stoplight": { - "id": "685e1l91iuxhv" - } - }, - "Grid": { - "description": "Model for Grid", - "examples": [ - { - "project_id": "p_xm3thidrblw4n7", - "base_id": "ds_g4ccx6e77h1dmi", - "fk_view_id": "vw_p2jcatxz4mvcfw", - "row_height": 1, - "meta": null, - "columns": [ - { - "id": "cl_phvuuwjrzcdo0g", - "base_id": "ds_g4ccx6e77h1dmi", - "project_id": "p_xm3thidrblw4n7", - "fk_model_id": "md_rsu68aqjsbyqtl", - "title": "Id", - "column_name": "id", - "uidt": "ID", - "dt": "int", - "np": "10", - "ns": "0", - "clen": null, - "cop": "1", - "pk": 1, - "pv": null, - "rqd": 1, - "un": 1, - "ct": "int unsigned", - "ai": 1, - "unique": 0, - "cdf": null, - "cc": "", - "csn": null, - "dtx": "specificType", - "dtxp": "", - "dtxs": "0", - "au": 0, - "validate": null, - "virtual": null, - "deleted": null, - "system": 0, - "order": 1, - "created_at": "2023-03-02 17:04:06", - "updated_at": "2023-03-02 17:04:06", - "meta": null - } - ] - } - ], - "title": "Grid Model", - "type": "object", - "properties": { - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID", - "x-stoplight": { - "id": "e3ti3fc0ocjyu" - } - }, - "project_id": { - "$ref": "#/components/schemas/Id", - "description": "Project ID", - "x-stoplight": { - "id": "e3ti3fc0ocjyu" - } - }, - "base_id": { - "$ref": "#/components/schemas/Id", - "description": "Base ID", - "x-stoplight": { - "id": "m8v3iyf1tidy9" - } - }, - "fk_view_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to View", - "x-stoplight": { - "id": "m8v3iyf1tidy9" - } - }, - "row_height": { - "type": "number", - "example": 1, - "description": "Row Height" - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "x-stoplight": { - "id": "n8cud3jyqw5yv" - }, - "description": "Meta info for Grid Model" - }, - "columns": { - "type": "array", - "x-stoplight": { - "id": "22y0gipx2jdf8" - }, - "description": "Grid View Columns", - "items": { - "$ref": "#/components/schemas/GridColumn", - "x-stoplight": { - "id": "nmzp6w3o6b24u" - } - } - } - }, - "x-stoplight": { - "id": "1xswddf91q5pu" - } - }, - "Grid - copy": { - "description": "Model for Grid", - "x-stoplight": { - "id": "xheueli0578g0" - }, - "examples": [ - { - "project_id": "p_xm3thidrblw4n7", - "base_id": "ds_g4ccx6e77h1dmi", - "fk_view_id": "vw_p2jcatxz4mvcfw", - "row_height": 1, - "meta": null, - "columns": [ - { - "id": "cl_phvuuwjrzcdo0g", - "base_id": "ds_g4ccx6e77h1dmi", - "project_id": "p_xm3thidrblw4n7", - "fk_model_id": "md_rsu68aqjsbyqtl", - "title": "Id", - "column_name": "id", - "uidt": "ID", - "dt": "int", - "np": "10", - "ns": "0", - "clen": null, - "cop": "1", - "pk": 1, - "pv": null, - "rqd": 1, - "un": 1, - "ct": "int unsigned", - "ai": 1, - "unique": 0, - "cdf": null, - "cc": "", - "csn": null, - "dtx": "specificType", - "dtxp": "", - "dtxs": "0", - "au": 0, - "validate": null, - "virtual": null, - "deleted": null, - "system": 0, - "order": 1, - "created_at": "2023-03-02 17:04:06", - "updated_at": "2023-03-02 17:04:06", - "meta": null - } - ] - } - ], - "title": "Grid Model", - "type": "object", - "properties": { - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID", - "x-stoplight": { - "id": "e3ti3fc0ocjyu" - } - }, - "project_id": { - "$ref": "#/components/schemas/Id", - "description": "Project ID", - "x-stoplight": { - "id": "e3ti3fc0ocjyu" - } - }, - "base_id": { - "$ref": "#/components/schemas/Id", - "description": "Base ID", - "x-stoplight": { - "id": "m8v3iyf1tidy9" - } - }, - "fk_view_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to View", - "x-stoplight": { - "id": "m8v3iyf1tidy9" - } - }, - "row_height": { - "type": "number", - "example": 1, - "description": "Row Height" - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "x-stoplight": { - "id": "n8cud3jyqw5yv" - }, - "description": "Meta info for Grid Model" - }, - "columns": { - "type": "array", - "x-stoplight": { - "id": "22y0gipx2jdf8" - }, - "description": "Grid View Columns", - "items": { - "$ref": "#/components/schemas/GridColumn", - "x-stoplight": { - "id": "nmzp6w3o6b24u" - } - } - } - } - }, - "GridColumn": { - "description": "Model for Grid Column", - "examples": [ - { - "id": "nc_c8jz4kxe6xvh11", - "fk_view_id": "vw_p2jcatxz4mvcfw", - "fk_column_id": "cl_c5knoi4xs4sfpt", - "project_id": "p_xm3thidrblw4n7", - "base_id": "ds_g4ccx6e77h1dmi", - "show": 0, - "order": 1, - "width": "200px", - "help": null - } - ], - "title": "Grid Column Model", - "type": "object", - "properties": { - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID", - "x-stoplight": { - "id": "jc14yojp52rqj" - } - }, - "fk_view_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to View", - "x-stoplight": { - "id": "vl18dbt5c2r8r" - } - }, - "fk_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Column", - "x-stoplight": { - "id": "2drg88fmodf3v" - } - }, - "project_id": { - "$ref": "#/components/schemas/Id", - "description": "Project ID", - "x-stoplight": { - "id": "2drg88fmodf3v" - } - }, - "base_id": { - "$ref": "#/components/schemas/Id", - "description": "Base ID", - "x-stoplight": { - "id": "2drg88fmodf3v" - } - }, - "show": { - "$ref": "#/components/schemas/Bool", - "x-stoplight": { - "id": "d47eer13oa8yr" - } - }, - "order": { - "type": "number", - "x-stoplight": { - "id": "d47eer13oa8yr" - }, - "example": 1, - "description": "Grid Column Order" - }, - "width": { - "type": "string", - "description": "Column Width", - "example": "200px" - }, - "help": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Column Help Text", - "x-stoplight": { - "id": "azwh6zn37qzkc" - } - } - }, - "x-stoplight": { - "id": "g06nri6t6h6ke" - } - }, - "GridColumnReq": { - "description": "Model for Grid Column Request", - "examples": [ - { - "fk_column_id": "cl_c5knoi4xs4sfpt", - "label": "My Column", - "width": "200px" - } - ], - "properties": { - "fk_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Column" - }, - "help": { - "maxLength": 255, - "type": "string" - }, - "label": { - "description": "The label of the column", - "example": "My Column", - "maxLength": 255, - "type": "string" - }, - "width": { - "description": "The width of the column", - "example": "200px", - "maxLength": 255, - "pattern": "^[0-9]+(px|%)$", - "type": "string" - } - }, - "title": "Grid Column Request Model", - "type": "object", - "x-stoplight": { - "id": "8v9cxve0332zg" - } - }, - "GridUpdateReq": { - "description": "Model for Grid View Update", - "x-stoplight": { - "id": "g10t5gray4bk5" - }, - "examples": [ - { - "row_height": "1", - "meta": null - } - ], - "title": "Grid View Update Model", - "type": "object", - "properties": { - "row_height": { - "type": "number", - "x-stoplight": { - "id": "m5976ax1q13cr" - }, - "description": "Row Height", - "example": 1 - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "x-stoplight": { - "id": "dugbkhe9iupqu" - }, - "description": "Meta Info for grid view" - } - } - }, - "Hook": { - "description": "Model for Hook", - "examples": [ - { - "active": 0, - "async": 0, - "description": "This is my hook description", - "env": "all", - "event": "after", - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "string", - "notification": "{\"type\":\"URL\",\"payload\":{\"method\":\"POST\",\"body\":\"{{ json data }}\",\"headers\":[{}],\"parameters\":[{}],\"auth\":\"\",\"path\":\"http://example.com\"}}", - "null": null, - "operation": "insert", - "retries": 10, - "retry_interval": 60000, - "timeout": 60000, - "title": "My Webhook" - } - ], - "title": "Hook Model", - "type": "object", - "x-stoplight": { - "id": "32blg2oqo6g7p" - }, - "properties": { - "active": { - "$ref": "#/components/schemas/Bool", - "description": "Is the hook active?" - }, - "async": { - "$ref": "#/components/schemas/Bool", - "description": "Is the hook aysnc?" - }, - "description": { - "type": "string", - "description": "Hook Description", - "example": "This is my hook description" - }, - "env": { - "type": "string", - "example": "all", - "description": "Environment for the hook" - }, - "event": { - "enum": ["after", "before"], - "type": "string", - "description": "Event Type for the operation", - "example": "after" - }, - "fk_model_id": { - "type": "string", - "description": "Foreign Key to Model", - "example": "md_rsu68aqjsbyqtl" - }, - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "notification": { - "description": "Hook Notification including info such as type, payload, method, body, and etc", - "type": ["object", "string"] - }, - "operation": { - "enum": [ - "insert", - "update", - "delete", - "bulkInsert", - "bulkUpdate", - "bulkDelete" - ], - "type": "string", - "description": "Hook Operation", - "example": "insert" - }, - "retries": { - "type": "number", - "description": "Retry Count", - "example": 10 - }, - "retry_interval": { - "type": "number", - "description": "Retry Interval", - "example": 60000 - }, - "timeout": { - "type": "number", - "example": 60000, - "description": "Timeout" - }, - "title": { - "type": "string", - "description": "Hook Title", - "example": "My Webhook" - }, - "type": { - "type": "string", - "description": "Hook Type" - }, - "version": { - "type": "string", - "x-stoplight": { - "id": "socewqvadj91n" - }, - "example": "v2", - "description": "Hook Version", - "enum": ["v1", "v2"] - } - } - }, - "HookReq": { - "description": "Model for Hook", - "x-stoplight": { - "id": "85vr8fx3oea31" - }, - "examples": [ - { - "active": 0, - "async": 0, - "description": "This is my hook description", - "env": "all", - "event": "after", - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "string", - "notification": "{\"type\":\"URL\",\"payload\":{\"method\":\"POST\",\"body\":\"{{ json data }}\",\"headers\":[{}],\"parameters\":[{}],\"auth\":\"\",\"path\":\"http://example.com\"}}", - "null": null, - "operation": "insert", - "retries": 10, - "retry_interval": 60000, - "timeout": 60000, - "title": "My Webhook", - "condition": false - } - ], - "title": "Hook Request Model", - "type": "object", - "properties": { - "active": { - "$ref": "#/components/schemas/Bool", - "description": "Is the hook active?" - }, - "async": { - "$ref": "#/components/schemas/Bool", - "description": "Is the hook aysnc?" - }, - "description": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Hook Description" - }, - "env": { - "type": "string", - "example": "all", - "description": "Environment for the hook" - }, - "event": { - "enum": ["after", "before"], - "type": "string", - "description": "Event Type for the operation", - "example": "after" - }, - "fk_model_id": { - "type": "string", - "description": "Foreign Key to Model", - "example": "md_rsu68aqjsbyqtl" - }, - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "notification": { - "description": "Hook Notification including info such as type, payload, method, body, and etc", - "type": ["object", "string"] - }, - "operation": { - "enum": [ - "insert", - "update", - "delete", - "bulkInsert", - "bulkUpdate", - "bulkDelete" - ], - "type": "string", - "description": "Hook Operation", - "example": "insert" - }, - "retries": { - "type": "number", - "description": "Retry Count", - "example": 10 - }, - "retry_interval": { - "type": "number", - "description": "Retry Interval", - "example": 60000 - }, - "timeout": { - "type": "number", - "example": 60000, - "description": "Timeout" - }, - "title": { - "type": "string", - "description": "Hook Title", - "example": "My Webhook" - }, - "type": { - "type": ["string", "null"], - "description": "Hook Type" - }, - "condition": { - "$ref": "#/components/schemas/Bool", - "x-stoplight": { - "id": "wwzoum7rrlwun" - }, - "description": "Is this hook assoicated with some filters" - } - }, - "required": ["event", "notification", "operation", "title"] - }, - "HookList": { - "description": "Model for Hook List", - "examples": [ - { - "list": [ - { - "active": 0, - "async": 0, - "description": "This is my hook description", - "env": "all", - "event": "after", - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "string", - "notification": "{\"type\":\"URL\",\"payload\":{\"method\":\"POST\",\"body\":\"{{ json data }}\",\"headers\":[{}],\"parameters\":[{}],\"auth\":\"\",\"path\":\"http://example.com\"}}", - "null": null, - "operation": "insert", - "retries": 10, - "retry_interval": 60000, - "timeout": 60000, - "title": "My Webhook" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - ], - "title": "Hook List Model", - "type": "object", - "x-examples": { - "example-1": { - "bases": { - "list": [ - { - "alias": "string", - "database": "string", - "host": "string", - "id": "string", - "params": "string", - "password": "string", - "port": 0, - "project_id": "string", - "ssl": "string", - "type": "string", - "url": "string", - "username": "string" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "pageSize": 0, - "sort": "string", - "totalRows": 0 - } - } - } - }, - "properties": { - "list": { - "minItems": 1, - "type": "array", - "uniqueItems": true, - "description": "List of hook objects", - "items": { - "$ref": "#/components/schemas/Hook" - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated" - } - }, - "required": ["list", "pageInfo"], - "x-stoplight": { - "id": "n2sbatqu55day" - } - }, - "HookLog": { - "description": "Model for Hook Log", - "examples": [ - { - "base_id": "ds_jxuewivwbxeum2", - "event": "after", - "execution_time": "98", - "fk_hook_id": "hk_035ijv5qdi97y5", - "id": "string", - "notifications": "{\"type\":\"URL\",\"payload\":{\"method\":\"POST\",\"body\":\"{{ json data }}\",\"headers\":[{}],\"parameters\":[{}],\"auth\":\"\",\"path\":\"https://webhook.site/6eb45ce5-b611-4be1-8b96-c2965755662b\"}}", - "operation": "insert", - "payload": "{\"method\":\"POST\",\"body\":\"{{ json data }}\",\"headers\":[{}],\"parameters\":[{}],\"auth\":\"\",\"path\":\"https://webhook.site/6eb45ce5-b611-4be1-8b96-c2965755662b\"}", - "project_id": "p_tbhl1hnycvhe5l", - "response": "{\"status\":200,\"statusText\":\"OK\",\"headers\":{\"server\":\"nginx\",\"content-type\":\"text/plain; charset=UTF-8\",\"transfer-encoding\":\"chunked\",\"connection\":\"close\",\"vary\":\"Accept-Encoding\",\"x-request-id\":\"53844a7d-ede8-4798-adf7-8af441908a72\",\"x-token-id\":\"6eb45ce5-b611-4be1-8b96-c2965755662b\",\"cache-control\":\"no-cache, private\",\"date\":\"Fri, 24 Mar 2023 10:50:10 GMT\"},\"config\":{\"url\":\"https://webhook.site/6eb45ce5-b611-4be1-8b96-c2965755662b\",\"method\":\"post\",\"data\":\"{\\\"type\\\":\\\"records.after.insert\\\",\\\"id\\\":\\\"a77d97dc-a3e4-4719-9b46-45f93e0cc99a\\\",\\\"data\\\":{\\\"table_id\\\":\\\"md_d8v403o74mf5lf\\\",\\\"table_name\\\":\\\"Sheet-2\\\"}}\",\"headers\":{\"Accept\":\"application/json, text/plain, */*\",\"Content-Type\":\"application/x-www-form-urlencoded\",\"User-Agent\":\"axios/0.21.4\",\"Content-Length\":138},\"params\":{}}}", - "test_call": 0, - "triggered_by": "w@nocodb.com", - "type": "URL" - } - ], - "title": "Hook Log Model", - "type": "object", - "x-stoplight": { - "id": "ni303795b18y5" - }, - "properties": { - "base_id": { - "type": "string", - "description": "Unique Base ID", - "example": "ds_jxuewivwbxeum2" - }, - "conditions": { - "type": "string", - "description": "Hook Conditions" - }, - "error": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Error" - }, - "error_code": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Error Code" - }, - "error_message": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Error Message" - }, - "event": { - "type": "string", - "description": "Hook Event", - "example": "after", - "enum": ["after", "before"] - }, - "execution_time": { - "type": "string", - "description": "Execution Time in milliseconds", - "example": "98" - }, - "fk_hook_id": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Foreign Key to Hook" - }, - "id": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Unique ID" - }, - "notifications": { - "type": "string", - "description": "Hook Notification" - }, - "operation": { - "type": "string", - "description": "Hook Operation", - "enum": [ - "insert", - "update", - "delete", - "bulkInsert", - "bulkUpdate", - "bulkDelete" - ], - "example": "insert" - }, - "payload": { - "type": "string", - "description": "Hook Payload", - "example": "{\"method\":\"POST\",\"body\":\"{{ json data }}\",\"headers\":[{}],\"parameters\":[{}],\"auth\":\"\",\"path\":\"https://webhook.site/6eb45ce5-b611-4be1-8b96-c2965755662b\"}" - }, - "project_id": { - "type": "string", - "description": "Project ID", - "example": "p_tbhl1hnycvhe5l" - }, - "response": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Hook Response" - }, - "test_call": { - "$ref": "#/components/schemas/Bool", - "description": "Is this testing hook call?" - }, - "triggered_by": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Who triggered the hook?" - }, - "type": { - "type": "string", - "example": "URL", - "description": "Hook Type" - } - } - }, - "HookLogList": { - "description": "Model for Hook Log List", - "x-stoplight": { - "id": "tfv7y629w2ap2" - }, - "examples": [], - "title": "Hook Log List Model", - "type": "object", - "x-examples": { - "example-1": { - "bases": { - "list": [ - { - "alias": "string", - "database": "string", - "host": "string", - "id": "string", - "params": "string", - "password": "string", - "port": 0, - "project_id": "string", - "ssl": "string", - "type": "string", - "url": "string", - "username": "string" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "pageSize": 0, - "sort": "string", - "totalRows": 0 - } - } - } - }, - "properties": { - "list": { - "minItems": 1, - "type": "array", - "uniqueItems": true, - "description": "List of hook objects", - "items": { - "$ref": "#/components/schemas/HookLog" - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated" - } - }, - "required": ["list", "pageInfo"] - }, - "HookTestReq": { - "description": "Model for Hook Test Request", - "examples": [ - { - "hook": { - "active": 0, - "async": 0, - "description": "This is my hook description", - "env": "all", - "event": "after", - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "string", - "notification": "{\"type\":\"URL\",\"payload\":{\"method\":\"POST\",\"body\":\"{{ json data }}\",\"headers\":[{}],\"parameters\":[{}],\"auth\":\"\",\"path\":\"http://example.com\"}}", - "null": null, - "operation": "insert", - "retries": 10, - "retry_interval": 60000, - "timeout": 60000, - "title": "My Webhook" - }, - "payload": { - "data": { - "Id": 1, - "Title": "Sample Text", - "CreatedAt": "2023-03-03T10:03:06.484Z", - "UpdatedAt": "2023-03-03T10:03:06.484Z", - "attachment": [ - { - "url": "https://nocodb.com/dummy.png", - "title": "image.png", - "mimetype": "image/png", - "size": 0 - } - ], - "f": "Sample Output" - } - } - } - ], - "title": "Hook Test Request Model", - "type": "object", - "properties": { - "hook": { - "$ref": "#/components/schemas/HookReq" - }, - "payload": { - "description": "Payload to be sent" - } - }, - "required": ["hook", "payload"], - "x-stoplight": { - "id": "w64q11jiv01np" - } - }, - "Id": { - "description": "Model for ID", - "examples": ["string"], - "maxLength": 20, - "minLength": 0, - "title": "ID Model", - "type": "string", - "x-stoplight": { - "id": "obj8r7jhyfoqg" - } - }, - "Kanban": { - "description": "Model for Kanban", - "examples": [ - { - "id": "vw_wqs4zheuo5lgdy", - "fk_grp_col_id": "cl_3704cxcbqt7sj7", - "fk_view_id": "vw_wqs4zheuo5lgdy", - "fk_cover_image_col_id": null, - "columns": [ - { - "id": "kvc_2skkg5mi1eb37f", - "fk_column_id": "cl_hzos4ghyncqi4k", - "fk_view_id": "vw_wqs4zheuo5lgdy", - "base_id": "ds_hd4ojj0xpquaam", - "project_id": "p_kzfl5lb0t3tcok", - "title": "string", - "show": 0, - "order": "1" - } - ], - "meta": null, - "title": "My Kanban" - } - ], - "title": "Kanban Model", - "type": "object", - "properties": { - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "fk_grp_col_id": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Grouping Field Column ID" - }, - "fk_view_id": { - "$ref": "#/components/schemas/Id", - "x-stoplight": { - "id": "1kgw1w06b97nl" - }, - "description": "View ID" - }, - "fk_cover_image_col_id": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Cover Image Column ID" - }, - "columns": { - "type": "array", - "description": "Kanban Columns", - "items": { - "$ref": "#/components/schemas/KanbanColumn" - } - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "description": "Meta Info for Kanban" - }, - "title": { - "type": "string", - "description": "Kanban Title", - "example": "My Kanban" - } - }, - "x-stoplight": { - "id": "sfbbvgbcv7je6" - } - }, - "KanbanColumn": { - "description": "Model for Kanban Column", - "examples": [ - { - "id": "kvc_2skkg5mi1eb37f", - "fk_column_id": "cl_hzos4ghyncqi4k", - "fk_view_id": "vw_wqs4zheuo5lgdy", - "base_id": "ds_hd4ojj0xpquaam", - "project_id": "p_kzfl5lb0t3tcok", - "title": "string", - "show": 0, - "order": "1" - } - ], - "title": "Kanban Column Model", - "type": "object", - "properties": { - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "fk_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Column" - }, - "fk_view_id": { - "$ref": "#/components/schemas/Id", - "x-stoplight": { - "id": "t1fy4zy561ih8" - }, - "description": "Foreign Key to View" - }, - "base_id": { - "$ref": "#/components/schemas/Id", - "x-stoplight": { - "id": "uqq8xmyz97t1u" - }, - "description": "Baes ID\n" - }, - "project_id": { - "$ref": "#/components/schemas/Id", - "x-stoplight": { - "id": "uqq8xmyz97t1u" - }, - "description": "Project ID" - }, - "title": { - "x-stoplight": { - "id": "uqq8xmyz97t1u" - }, - "description": "Project ID", - "type": "string" - }, - "show": { - "$ref": "#/components/schemas/Bool", - "x-stoplight": { - "id": "uqq8xmyz97t1u" - }, - "description": "Is this column shown?" - }, - "order": { - "type": "number", - "x-stoplight": { - "id": "pbnchzgci5dwa" - }, - "example": 1, - "description": "Column Order" - } - }, - "x-stoplight": { - "id": "epfedw9ccxgxe" - } - }, - "KanbanUpdateReq": { - "description": "Model for Kanban Update Request", - "examples": [ - { - "fk_grp_col_id": "cl_g0a89q9xdry3lu", - "fk_cover_image_col_id": "cl_ib8l4j1kiu1efx", - "meta": { - "cl_g0a89q9xdry3lu": [ - { - "id": "uncategorized", - "title": null, - "order": 0, - "color": "#c2f5e8", - "collapsed": false - }, - { - "id": "sl_ihyva6jx6dg0fc", - "fk_column_id": "cl_g0a89q9xdry3lu", - "title": "a", - "color": "#cfdffe", - "order": 1, - "collapsed": false - }, - { - "id": "sl_gqdm5v6t8aetoa", - "fk_column_id": "cl_g0a89q9xdry3lu", - "title": "b", - "color": "#d0f1fd", - "order": 2, - "collapsed": false - }, - { - "id": "sl_eipnl0kn7a9d3c", - "fk_column_id": "cl_g0a89q9xdry3lu", - "title": "cc", - "color": "#c2f5e8", - "order": 3, - "collapsed": false - }, - { - "id": "sl_dei8p2jq0cnlv0", - "fk_column_id": "cl_g0a89q9xdry3lu", - "title": "d", - "color": "#ffdaf6", - "order": 4, - "collapsed": false - } - ] - } - } - ], - "title": "Kanban Update Request Model", - "type": "object", - "properties": { - "fk_grp_col_id": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Foreign Key to Grouping Field Column" - }, - "fk_cover_image_col_id": { - "$ref": "#/components/schemas/StringOrNull", - "x-stoplight": { - "id": "81wn4hzj76wod" - }, - "description": "Foreign Key to Cover Image Column" - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "x-stoplight": { - "id": "stsvdmkli1b0r" - }, - "description": "Meta Info" - } - }, - "x-stoplight": { - "id": "b1jlyk12kfuwx" - } - }, - "LicenseReq": { - "description": "Model for Kanban Request", - "examples": [ - { - "key": "1234567890" - } - ], - "properties": { - "key": { - "description": "The license key", - "example": "1234567890", - "maxLength": 255, - "minLength": 10, - "type": "string" - } - }, - "title": "License Key Request Model", - "type": "object", - "x-stoplight": { - "id": "trgk6qlmgdyfo" - } - }, - "LinkToAnotherColumnReq": { - "description": "Model for LinkToAnotherColumn Request", - "examples": [ - { - "childId": "string", - "parentId": "string", - "title": "string", - "type": "hm", - "uidt": "LinkToAnotherRecord", - "virtual": true - } - ], - "properties": { - "childId": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to chhild column" - }, - "parentId": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to parent column" - }, - "title": { - "maxLength": 255, - "minLength": 1, - "type": "string", - "description": "The title of the virtual column" - }, - "type": { - "enum": ["bt", "hm", "mm"], - "type": "string", - "description": "The type of the relationship" - }, - "uidt": { - "enum": ["LinkToAnotherRecord"], - "type": "string", - "description": "Abstract type of the relationship" - }, - "virtual": { - "$ref": "#/components/schemas/Bool", - "description": "Is this relationship virtual?" - } - }, - "required": ["childId", "parentId", "title", "type", "uidt"], - "title": "LinkToAnotherColumn Request Model", - "type": "object", - "x-stoplight": { - "id": "x59gz5reg12x3" - } - }, - "LinkToAnotherRecord": { - "description": "Model for LinkToAnotherRecord", - "examples": [ - { - "deleted": "string", - "dr": "string", - "fk_child_column_id": "string", - "fk_column_id": "string", - "fk_index_name": "string", - "fk_mm_child_column_id": "string", - "fk_mm_model_id": "string", - "fk_mm_parent_column_id": "string", - "fk_parent_column_id": "string", - "fk_related_model_id": "string", - "id": "string", - "order": "string", - "type": "string", - "ur": "string", - "virtual": true - } - ], - "properties": { - "deleted": { - "type": "string" - }, - "dr": { - "type": "string" - }, - "fk_child_column_id": { - "type": "string" - }, - "fk_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Column" - }, - "fk_index_name": { - "type": "string" - }, - "fk_mm_child_column_id": { - "type": "string" - }, - "fk_mm_model_id": { - "type": "string" - }, - "fk_mm_parent_column_id": { - "type": "string" - }, - "fk_parent_column_id": { - "type": "string" - }, - "fk_related_model_id": { - "type": "string" - }, - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "order": { - "type": "string" - }, - "type": { - "type": "string" - }, - "ur": { - "type": "string" - }, - "virtual": { - "$ref": "#/components/schemas/Bool" - } - }, - "title": "LinkToAnotherRecord Model", - "type": "object", - "x-stoplight": { - "id": "27q0vnr79hxla" - } - }, - "Lookup": { - "description": "Model for Lookup", - "examples": [ - { - "id": "lk_mngsu0e45njbxr", - "fk_column_id": "cl_vdiy9bz7h11kdm", - "fk_relation_column_id": "cl_5jestblzneb649", - "fk_lookup_column_id": "cl_4cm47dtjphgqkv", - "order": 1 - } - ], - "title": "Lookup Model", - "type": "object", - "properties": { - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "fk_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Column" - }, - "fk_lookup_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Lookup Column" - }, - "fk_relation_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Relation Column" - }, - "order": { - "type": "number", - "description": "The order among the list", - "example": 1 - } - }, - "x-stoplight": { - "id": "guyozhka8sx1t" - } - }, - "LookupColumnReq": { - "description": "Model for Lookup Column Request", - "examples": [ - { - "fk_relation_column_id": "cl_5jestblzneb649", - "fk_lookup_column_id": "cl_4cm47dtjphgqkv", - "title": "My Lookup", - "uidt": "Lookup" - } - ], - "title": "Lookup Column Request Model", - "type": "object", - "properties": { - "fk_lookup_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Lookup Column" - }, - "fk_relation_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Relation Column" - }, - "title": { - "maxLength": 255, - "type": "string", - "description": "Lookup Title", - "example": "My Lookup" - }, - "uidt": { - "enum": ["Lookup"], - "type": "string", - "description": "UI DataType" - } - }, - "x-stoplight": { - "id": "hmeckhq2ciwpf" - } - }, - "Map": { - "description": "Model for Map", - "examples": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "columns": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "fk_column_id": "cl_8iw2o4ejzvdyna", - "fk_view_id": "vw_qjt7klod1p9kyv", - "id": "nc_46xcacqn4rc9xf", - "order": 1, - "project_id": "p_xm3thidrblw4n7", - "show": 1 - } - ], - "fk_geo_data_col_id": "cl_8iw2o4ejzvdyna", - "fk_view_id": "vw_qjt7klod1p9kyv", - "meta": {}, - "order": 0, - "project_id": "p_xm3thidrblw4n7", - "show": true, - "title": "My Map" - } - ], - "properties": { - "base_id": { - "description": "The ID of the base that this view belongs to", - "example": "ds_g4ccx6e77h1dmi", - "type": "string" - }, - "columns": { - "description": "Columns in this view", - "items": { - "$ref": "#/components/schemas/MapColumn" - }, - "type": "array" - }, - "fk_geo_data_col_id": { - "description": "Foreign Key to GeoData Column", - "example": "cl_8iw2o4ejzvdyna", - "type": "string" - }, - "fk_view_id": { - "description": "Unique ID for Map", - "example": "vw_qjt7klod1p9kyv", - "type": "string" - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "description": "Meta data for this view" - }, - "order": { - "description": "The order of the map list", - "type": "number" - }, - "project_id": { - "description": "The ID of the project that this view belongs to", - "example": "p_xm3thidrblw4n7", - "type": "string" - }, - "show": { - "description": "To show this Map or not", - "type": "boolean" - }, - "title": { - "description": "Title of Map View", - "example": "My Map", - "type": "string" - } - }, - "title": "Map Model", - "type": "object", - "x-stoplight": { - "id": "hd60sf3k0bs3w" - } - }, - "MapUpdateReq": { - "description": "Model for Map", - "x-stoplight": { - "id": "3hceyh9ukp5ln" - }, - "examples": [ - { - "fk_geo_data_col_id": "cl_8iw2o4ejzvdyna", - "meta": null - } - ], - "title": "Map View Update Request Model", - "type": "object", - "properties": { - "fk_geo_data_col_id": { - "description": "Foreign Key to GeoData Column", - "example": "cl_8iw2o4ejzvdyna", - "type": "string" - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "description": "Meta data for this view" - } - } - }, - "MapColumn": { - "description": "Model for Map Column", - "examples": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "fk_column_id": "cl_8iw2o4ejzvdyna", - "fk_view_id": "vw_qjt7klod1p9kyv", - "id": "nc_46xcacqn4rc9xf", - "order": 1, - "project_id": "p_xm3thidrblw4n7", - "show": 1 - } - ], - "properties": { - "base_id": { - "description": "The ID of the base that this map column belongs to", - "example": "ds_g4ccx6e77h1dmi", - "type": "string" - }, - "fk_column_id": { - "description": "Foreign Key to Column", - "example": "cl_8iw2o4ejzvdyna", - "type": "string" - }, - "fk_view_id": { - "description": "Foreign Key to View", - "example": "vw_qjt7klod1p9kyv", - "type": "string" - }, - "id": { - "description": "Unique ID of Map Column", - "example": "nc_46xcacqn4rc9xf", - "type": "string" - }, - "order": { - "description": "the order in the list of map columns", - "example": 1, - "type": "number" - }, - "project_id": { - "description": "The ID of the project that this map column belongs to", - "example": "p_xm3thidrblw4n7", - "type": "string" - }, - "show": { - "description": "Whether to show this column or not", - "example": 1, - "type": "number" - } - }, - "title": "Map Column Model", - "type": "object", - "x-stoplight": { - "id": "bvk0acuepoqw1" - } - }, - "Meta": { - "description": "Model for Meta", - "examples": [{}], - "oneOf": [ - { - "type": "null" - }, - { - "type": "object" - }, - { - "type": "string" - } - ], - "title": "Meta Model", - "x-stoplight": { - "id": "2ohjoms6hjcym" - } - }, - "ModelRoleVisibility": { - "description": "Model for ModelRoleVisibility", - "examples": [ - { - "base_id": "string", - "disabled": true, - "fk_model_id": "string", - "fk_view_id": "string", - "id": "string", - "project_id": "string", - "role": "string" - } - ], - "properties": { - "base_id": { - "type": "string" - }, - "disabled": { - "$ref": "#/components/schemas/Bool" - }, - "fk_model_id": { - "type": "string" - }, - "fk_view_id": { - "type": "string" - }, - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "project_id": { - "type": "string" - }, - "role": { - "type": "string" - } - }, - "title": "ModelRoleVisibility Model", - "type": "object", - "x-stoplight": { - "id": "68m1dblcswem2" - } - }, - "NormalColumnRequest": { - "description": "Model for Normal Column Request", - "examples": [ - { - "ai": true, - "au": true, - "cc": "string", - "cdf": "string", - "column_name": "string", - "csn": "string", - "dt": "string", - "dtx": "string", - "dtxp": 0, - "dtxs": 0, - "np": 0, - "ns": 0, - "pk": true, - "pv": true, - "rqd": true, - "title": "string", - "uidt": "ID", - "un": true, - "unique": true - } - ], - "properties": { - "ai": { - "$ref": "#/components/schemas/Bool", - "description": "Is this column auto-incremented?" - }, - "au": { - "$ref": "#/components/schemas/Bool", - "description": "Is this column auto-updated datetime field?" - }, - "cc": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Column Comment" - }, - "cdf": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Column Default Value" - }, - "column_name": { - "maxLength": 255, - "minLength": 1, - "type": "string", - "description": "Column Name" - }, - "csn": { - "$ref": "#/components/schemas/StringOrNull" - }, - "dt": { - "type": "string", - "description": "Data Type" - }, - "dtx": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Data Type Extra" - }, - "dtxp": { - "oneOf": [ - { - "$ref": "#/components/schemas/StringOrNull" - }, - { - "type": "number" - } - ], - "description": "Data Type Extra Precision" - }, - "dtxs": { - "oneOf": [ - { - "$ref": "#/components/schemas/StringOrNull" - }, - { - "type": "number" - } - ], - "description": "Data Type Extra Scale" - }, - "np": { - "oneOf": [ - { - "$ref": "#/components/schemas/StringOrNull" - }, - { - "type": "integer" - } - ], - "description": "Numeric Precision" - }, - "ns": { - "oneOf": [ - { - "$ref": "#/components/schemas/StringOrNull" - }, - { - "type": "integer" - } - ], - "description": "Numeric Scale" - }, - "pk": { - "$ref": "#/components/schemas/Bool", - "description": "Is this column a primary key?" - }, - "pv": { - "$ref": "#/components/schemas/Bool", - "description": "Is this column a primary value?" - }, - "rqd": { - "$ref": "#/components/schemas/Bool", - "description": "Is this column required?" - }, - "title": { - "maxLength": 255, - "type": "string", - "description": "Column Title" - }, - "uidt": { - "enum": [ - "Attachment", - "AutoNumber", - "Barcode", - "Button", - "Checkbox", - "Collaborator", - "Count", - "CreateTime", - "Currency", - "Date", - "DateTime", - "Decimal", - "Duration", - "Email", - "Formula", - "ForeignKey", - "GeoData", - "Geometry", - "ID", - "JSON", - "LastModifiedTime", - "LongText", - "LinkToAnotherRecord", - "Lookup", - "MultiSelect", - "Number", - "Percent", - "PhoneNumber", - "Rating", - "Rollup", - "SingleLineText", - "SingleSelect", - "SpecificDBType", - "Time", - "URL", - "Year", - "QrCode" - ], - "type": "string", - "description": "UI Data Type" - }, - "un": { - "$ref": "#/components/schemas/Bool", - "description": "Is this column unique?" - }, - "unique": { - "$ref": "#/components/schemas/Bool", - "description": "Is this column unique?" - } - }, - "title": "Normal Column Request Model", - "type": "object", - "required": ["column_name"], - "x-stoplight": { - "id": "b67hswwa49t9u" - } - }, - "OrgUserReq": { - "description": "Model for Organisation User Update Request", - "examples": [ - { - "email": "user@example.com", - "roles": "org-level-creator" - } - ], - "properties": { - "email": { - "format": "email", - "type": "string" - }, - "roles": { - "enum": ["org-level-creator", "org-level-viewer"], - "type": "string", - "description": "Roles for the project user" - } - }, - "title": "Organisation User Request Model", - "type": "object", - "x-stoplight": { - "id": "hs5aforkqjbkb" - } - }, - "Paginated": { - "description": "Model for Paginated", - "examples": [ - { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - ], - "properties": { - "isFirstPage": { - "description": "Is the current page the first page", - "type": "boolean" - }, - "isLastPage": { - "description": "Is the current page the last page", - "type": "boolean" - }, - "page": { - "description": "The current page", - "example": 1, - "type": "number" - }, - "pageSize": { - "description": "The number of pages", - "example": 10, - "type": "number" - }, - "totalRows": { - "description": "The number of rows in the given result", - "example": 1, - "type": "number" - } - }, - "title": "Paginated Model", - "type": "object", - "x-stoplight": { - "id": "ny0v2losvmitz" - } - }, - "Password": { - "description": "Model for Password", - "example": "password123456789", - "examples": ["password123456789"], - "minLength": 8, - "title": "Password Model", - "type": "string", - "x-stoplight": { - "id": "c6iocwuo2j8z8" - } - }, - "PasswordChangeReq": { - "description": "Model for Password Change Request", - "examples": [ - { - "currentPassword": "currentpassword", - "newPassword": "newpassword" - } - ], - "properties": { - "currentPassword": { - "type": "string" - }, - "newPassword": { - "minLength": 8, - "type": "string" - } - }, - "required": ["currentPassword", "newPassword"], - "title": "Password Change Request Model", - "type": "object", - "x-stoplight": { - "id": "99dogahvh0gla" - } - }, - "PasswordForgotReq": { - "description": "Model for Password Forgot Request", - "examples": [ - { - "email": "user@example.com" - } - ], - "properties": { - "email": { - "description": "Email address of the user", - "format": "email", - "type": "string" - } - }, - "required": ["email"], - "title": "Password Forgot Request Model", - "type": "object", - "x-stoplight": { - "id": "1kkft7m54ax45" - } - }, - "PasswordResetReq": { - "description": "Model for Password Reset Request", - "examples": [ - { - "password": "newpassword" - } - ], - "properties": { - "password": { - "description": "New password", - "example": "newpassword", - "minLength": 8, - "type": "string" - } - }, - "required": ["password"], - "title": "Password Reset Request Model", - "type": "object", - "x-stoplight": { - "id": "i3gzz403zjwh8" - } - }, - "Plugin": { - "description": "Model for Plugin", - "examples": [ - { - "id": "nc_tljibbzcyjrhcc", - "title": "S3", - "description": "Amazon Simple Storage Service (Amazon S3) is an object storage service that offers industry-leading scalability, data availability, security, and performance.", - "active": true, - "rating": null, - "version": "0.0.1", - "docs": null, - "status": "install", - "status_details": null, - "logo": "plugins/s3.png", - "icon": null, - "tags": "Storage", - "category": "Storage", - "input_schema": "{\"title\":\"Configure Amazon S3\",\"items\":[{\"key\":\"bucket\",\"label\":\"Bucket Name\",\"placeholder\":\"Bucket Name\",\"type\":\"SingleLineText\",\"required\":true},{\"key\":\"region\",\"label\":\"Region\",\"placeholder\":\"Region\",\"type\":\"SingleLineText\",\"required\":true},{\"key\":\"access_key\",\"label\":\"Access Key\",\"placeholder\":\"Access Key\",\"type\":\"SingleLineText\",\"required\":true},{\"key\":\"access_secret\",\"label\":\"Access Secret\",\"placeholder\":\"Access Secret\",\"type\":\"Password\",\"required\":true}],\"actions\":[{\"label\":\"Test\",\"placeholder\":\"Test\",\"key\":\"test\",\"actionType\":\"TEST\",\"type\":\"Button\"},{\"label\":\"Save\",\"placeholder\":\"Save\",\"key\":\"save\",\"actionType\":\"SUBMIT\",\"type\":\"Button\"}],\"msgOnInstall\":\"Successfully installed and attachment will be stored in AWS S3\",\"msgOnUninstall\":\"\"}", - "input": "{\"bucket\":\"my-bucket\",\"region\":\"us-west-004\",\"access_key\":\"redacted\",\"access_secret\":\"redacted\"}", - "creator": null, - "creator_website": null, - "price": null - } - ], - "title": "Plugin Model", - "type": "object", - "properties": { - "active": { - "$ref": "#/components/schemas/Bool", - "description": "Is plguin active?" - }, - "category": { - "type": "string", - "description": "Plugin Category", - "example": "Storage" - }, - "creator": { - "type": "string", - "description": "Plugin Creator (Not in use)" - }, - "creator_website": { - "type": "string", - "description": "Plugin Creator website (Not in use)" - }, - "description": { - "type": "string", - "description": "Plugin Description", - "example": "Amazon Simple Storage Service (Amazon S3) is an object storage service that offers industry-leading scalability, data availability, security, and performance." - }, - "docs": { - "type": "string", - "description": "Documentation of plugin (Not in use)" - }, - "icon": { - "type": "string", - "description": "Plugin Icon (Not in use)" - }, - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "input": { - "oneOf": [ - { - "$ref": "#/components/schemas/StringOrNull" - }, - { - "type": "integer" - } - ], - "description": "Plugin Input" - }, - "input_schema": { - "type": "string", - "description": "Plugin Input Schema\n" - }, - "logo": { - "type": "string", - "description": "Plugin logo", - "example": "plugins/s3.png" - }, - "price": { - "type": "string", - "description": "Plugin Price (Not in use)" - }, - "rating": { - "type": "number", - "description": "Plugin Rating (Not in use)" - }, - "status": { - "type": "string", - "description": "Plugin Status", - "example": "install" - }, - "status_details": { - "type": "string", - "description": "Not in use" - }, - "tags": { - "type": "string", - "description": "Plugin tags", - "example": "Storage" - }, - "title": { - "type": "string", - "description": "Plugin Title" - }, - "version": { - "type": "string", - "description": "Plugin Version", - "example": "0.0.1" - } - }, - "x-stoplight": { - "id": "uux5n95kbh2r5" - } - }, - "PluginReq": { - "description": "Model for Plugin Request", - "examples": [ - { - "active": 0, - "input": "{\"bucket\":\"my-bucket\",\"region\":\"us-west-004\",\"access_key\":\"redacted\",\"access_secret\":\"redacted\"}" - } - ], - "title": "Plugin Reqeust", - "type": "object", - "properties": { - "active": { - "$ref": "#/components/schemas/Bool", - "description": "Is Plugin Active?" - }, - "input": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Plugin Input" - } - }, - "x-stoplight": { - "id": "pci8zg4wgn3bx" - } - }, - "PluginTestReq": { - "description": "Model for Plugin Test Request", - "examples": [ - { - "title": "Plugin Foo", - "input": "{\"bucket\":\"my-bucket\",\"region\":\"us-west-004\",\"access_key\":\"redacted\",\"access_secret\":\"redacted\"}", - "category": "Email" - } - ], - "title": "Plugin Test Request Model", - "type": "object", - "properties": { - "title": { - "maxLength": 45, - "type": "string", - "description": "Plugin Title" - }, - "input": { - "oneOf": [ - { - "type": "string", - "description": "Plugin Input as JSON string" - }, - { - "description": "Plugin Input", - "type": "object" - } - ] - }, - "category": { - "x-stoplight": { - "id": "rg3i3ov9rs6d0" - }, - "type": "string", - "example": "Email" - } - }, - "required": ["title", "input", "category"], - "x-stoplight": { - "id": "gest5kbecpjdi" - } - }, - "Project": { - "description": "Model for Project", - "examples": [ - { - "bases": [ - { - "alias": "string", - "config": null, - "enabled": true, - "id": "string", - "inflection_column": "camelize", - "inflection_table": "camelize", - "is_meta": true, - "order": 1, - "project_id": "string", - "type": "mysql2", - "updated_at": "2023-03-01 14:27:36" - } - ], - "color": "#24716E", - "created_at": "2023-03-01 14:27:36", - "deleted": true, - "description": "This is my project description", - "id": "p_124hhlkbeasewh", - "is_meta": true, - "meta": {}, - "order": 0, - "prefix": "nc_vm5q__", - "status": "string", - "title": "my-project" - } - ], - "title": "Project Model", - "type": "object", - "properties": { - "bases": { - "description": "List of base models", - "type": "array", - "items": { - "$ref": "#/components/schemas/Base" - } - }, - "color": { - "description": "Primary Theme Color", - "example": "#24716E", - "type": "string" - }, - "deleted": { - "$ref": "#/components/schemas/Bool", - "description": "Is the project deleted" - }, - "description": { - "description": "Project Description", - "example": "This is my project description", - "type": "string" - }, - "id": { - "description": "Unique Project ID", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "is_meta": { - "$ref": "#/components/schemas/Bool" - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "description": "Meta Info such as theme colors" - }, - "order": { - "description": "The order in project list", - "type": "number" - }, - "prefix": { - "description": "Project prefix. Used in XCDB only.", - "example": "nc_vm5q__", - "type": "string" - }, - "status": { - "type": "string" - }, - "title": { - "description": "Project Title", - "example": "my-project", - "type": "string" - } - }, - "x-stoplight": { - "id": "gae6rj3whdnj9" - } - }, - "ProjectList": { - "description": "Model for Project List", - "examples": [ - { - "list": [ - { - "bases": [ - { - "alias": "string", - "config": null, - "created_at": "2023-03-01 14:27:36", - "enabled": true, - "id": "string", - "inflection_column": "camelize", - "inflection_table": "camelize", - "is_meta": true, - "order": 1, - "project_id": "string", - "type": "mysql2", - "updated_at": "2023-03-01 14:27:36" - } - ], - "color": "#24716E", - "created_at": "2023-03-01 14:27:36", - "deleted": true, - "description": "This is my project description", - "id": "p_124hhlkbeasewh", - "is_meta": true, - "meta": {}, - "order": 0, - "prefix": "nc_vm5q__", - "status": "string", - "title": "my-project", - "updated_at": "2023-03-01 14:27:36" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - ], - "title": "Project List Model", - "type": "object", - "x-examples": { - "example-1": { - "bases": { - "list": [ - { - "alias": "string", - "database": "string", - "host": "string", - "id": "string", - "params": "string", - "password": "string", - "port": 0, - "project_id": "string", - "ssl": "string", - "type": "string", - "url": "string", - "username": "string" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "pageSize": 0, - "sort": "string", - "totalRows": 0 - } - } - } - }, - "properties": { - "list": { - "description": "List of Project Models", - "minItems": 1, - "type": "array", - "uniqueItems": true, - "items": { - "$ref": "#/components/schemas/Project" - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated", - "description": "Pagination Info" - } - }, - "required": ["list", "pageInfo"], - "x-stoplight": { - "id": "xbosckfm1h9l0" - } - }, - "ProjectReq": { - "description": "Model for Project Request", - "examples": [ - { - "bases": [ - { - "alias": "My Base", - "config": null, - "inflection_column": "camelize", - "inflection_table": "camelize", - "is_meta": true, - "type": "mysql" - } - ], - "color": "#24716E", - "description": "This is my project description", - "title": "My Project" - } - ], - "properties": { - "bases": { - "description": "Array of Bases", - "items": { - "$ref": "#/components/schemas/BaseReq" - }, - "type": "array" - }, - "color": { - "description": "Primary Theme Color", - "example": "#24716E", - "maxLength": 50, - "type": "string" - }, - "description": { - "description": "Project Description", - "example": "This is my project description", - "type": "string" - }, - "title": { - "description": "Project Title", - "example": "My Project", - "maxLength": 128, - "minLength": 1, - "type": "string" - } - }, - "required": ["title"], - "title": "Project Request Model", - "type": "object", - "x-stoplight": { - "id": "aicbp4keo57ld" - } - }, - "ProjectUpdateReq": { - "description": "Model for Project Update Request", - "x-stoplight": { - "id": "83257b35r118q" - }, - "examples": [ - { - "color": "#24716E", - "meta": null, - "title": "My Project" - } - ], - "title": "Project Update Request Model", - "type": "object", - "properties": { - "color": { - "description": "Primary Theme Color", - "example": "#24716E", - "maxLength": 50, - "type": "string" - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "description": "Project Meta", - "x-stoplight": { - "id": "m05w9sbwqgul3" - } - }, - "title": { - "description": "Project Title", - "example": "My Project", - "maxLength": 128, - "minLength": 1, - "type": "string" - } - } - }, - "ProjectUserReq": { - "description": "Model for Project User Request", - "examples": [ - { - "email": "user@example.com", - "roles": "owner" - } - ], - "title": "Project User Request Model", - "type": "object", - "properties": { - "email": { - "format": "email", - "type": "string", - "description": "Project User Email" - }, - "roles": { - "enum": [ - "commenter", - "editor", - "guest", - "owner", - "viewer", - "creator" - ], - "type": "string", - "description": "Project User Role" - } - }, - "required": ["email", "roles"], - "x-stoplight": { - "id": "tq2wpd2agebjz" - } - }, - "Rollup": { - "description": "Model for Rollup", - "examples": [ - { - "id": "rl_kc19pbdkij8wly", - "fk_column_id": "cl_588b63mneri2yi", - "fk_relation_column_id": "cl_c09q6eu6hsvn4s", - "fk_rollup_column_id": "cl_m62i1vyl23n8co", - "rollup_function": "count" - } - ], - "title": "Rollup Model", - "type": "object", - "properties": { - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "fk_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Column" - }, - "fk_relation_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign to Relation Column" - }, - "fk_rollup_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign to Rollup Column" - }, - "rollup_function": { - "type": "string", - "description": "Rollup Function", - "example": "count", - "enum": [ - "count", - "min", - "max", - "avg", - "countDistinct", - "sumDistinct", - "avgDistinct" - ] - } - }, - "x-stoplight": { - "id": "vdzh0qojyn9a9" - } - }, - "RollupColumnReq": { - "description": "Model for Rollup Column Request", - "examples": [ - { - "fk_relation_column_id": "cl_c09q6eu6hsvn4s", - "fk_rollup_column_id": "cl_m62i1vyl23n8co", - "title": "Rollup Column", - "rollup_function": "avg", - "uidt": "Rollup" - } - ], - "title": "Rollup Column Request Model", - "type": "object", - "properties": { - "fk_relation_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Relation Column" - }, - "fk_rollup_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Rollup Column" - }, - "title": { - "maxLength": 255, - "type": "string", - "description": "Rollup Column Title" - }, - "rollup_function": { - "enum": [ - "avg", - "avgDistinct", - "count", - "countDistinct", - "max", - "min", - "sum", - "sumDistinct" - ], - "type": "string", - "description": "Rollup Function" - }, - "uidt": { - "enum": ["Rollup"], - "type": "string", - "description": "UI DataType" - } - }, - "x-stoplight": { - "id": "uw9fq6lp1lone" - } - }, - "SelectOption": { - "description": "Model for SelectOption", - "examples": [ - { - "id": "sl_hvfeuagqtlzzbk", - "title": "Option A", - "fk_column_id": "cl_35zmvi2tezfipw", - "color": "#cfdffe", - "order": 1 - } - ], - "title": "SelectOption Model", - "type": "object", - "properties": { - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "title": { - "type": "string", - "description": "Option Title\n", - "example": "Option A" - }, - "fk_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Column" - }, - "color": { - "type": "string", - "description": "Option Color", - "example": "#cfdffe" - }, - "order": { - "type": "number", - "description": "The order among the options", - "example": 1 - } - }, - "x-stoplight": { - "id": "onnh5qie1ul32" - } - }, - "SelectOptions": { - "description": "Model for SelectOptions", - "examples": [ - { - "options": [ - { - "id": "sl_hvfeuagqtlzzbk", - "title": "Option A", - "fk_column_id": "cl_35zmvi2tezfipw", - "color": "#cfdffe", - "order": 1 - } - ] - } - ], - "title": "SelectOptions Model", - "type": "object", - "properties": { - "options": { - "type": "array", - "description": "Array of select options", - "items": { - "$ref": "#/components/schemas/SelectOption" - } - } - }, - "required": ["options"], - "x-stoplight": { - "id": "3i68n0spduuf9" - } - }, - "SharedBaseReq": { - "description": "Model for Shared Base Request", - "examples": [ - { - "password": "password123", - "roles": "editor" - } - ], - "title": "Shared Base Request Model", - "type": "object", - "properties": { - "password": { - "minLength": 8, - "type": "string", - "description": "Password to protect the base", - "example": "password123" - }, - "roles": { - "enum": ["commenter", "editor", "viewer"], - "type": "string", - "description": "The role given the target user", - "example": "editor" - } - }, - "x-stoplight": { - "id": "ep7ikmx3sudcl" - } - }, - "SharedView": { - "$ref": "#/components/schemas/View", - "description": "Model for Shared View", - "title": "SharedView", - "examples": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:46:31", - "fk_model_id": "md_mhs9z4r2ak98x0", - "id": "vw_lg052cnc1c26kf", - "is_default": 1, - "lock_type": "collaborative", - "meta": {}, - "order": 1, - "password": null, - "project_id": "p_xm3thidrblw4n7", - "show": 1, - "show_system_fields": null, - "title": "Sheet-1", - "type": 3, - "updated_at": "2023-03-02 17:46:31", - "uuid": null, - "view": { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:46:31", - "fk_view_id": "vw_lg052cnc1c26kf", - "meta": null, - "project_id": "p_xm3thidrblw4n7", - "row_height": null, - "updated_at": "2023-03-02 17:46:31", - "uuid": null - } - } - ], - "x-stoplight": { - "id": "fqfohevz2zj4u" - } - }, - "SharedViewList": { - "description": "Model for Shared View List", - "examples": [ - { - "list": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:46:31", - "fk_model_id": "md_mhs9z4r2ak98x0", - "id": "vw_lg052cnc1c26kf", - "is_default": 1, - "lock_type": "collaborative", - "meta": {}, - "order": 1, - "password": null, - "project_id": "p_xm3thidrblw4n7", - "show": 1, - "show_system_fields": null, - "title": "Sheet-1", - "type": 3, - "updated_at": "2023-03-02 17:46:31", - "uuid": null, - "view": { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:46:31", - "fk_view_id": "vw_lg052cnc1c26kf", - "meta": null, - "project_id": "p_xm3thidrblw4n7", - "row_height": null, - "updated_at": "2023-03-02 17:46:31", - "uuid": null - } - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - ], - "title": "Shared View List Model", - "type": "object", - "x-examples": { - "example-1": { - "bases": { - "list": [ - { - "alias": "string", - "database": "string", - "host": "string", - "id": "string", - "params": "string", - "password": "string", - "port": 0, - "project_id": "string", - "ssl": "string", - "type": "string", - "url": "string", - "username": "string" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "pageSize": 0, - "sort": "string", - "totalRows": 0 - } - } - } - }, - "properties": { - "list": { - "minItems": 1, - "type": "array", - "uniqueItems": true, - "description": "List of shared view objects", - "items": { - "$ref": "#/components/schemas/SharedView" - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated", - "description": "Paginated Info" - } - }, - "required": ["list", "pageInfo"], - "x-stoplight": { - "id": "zdpekhmw0wvj3" - } - }, - "SharedViewReq": { - "description": "Model for Shared View Request", - "examples": [ - { - "meta": {}, - "password": "123456789" - } - ], - "title": "Shared View Request Model", - "type": "object", - "properties": { - "meta": { - "$ref": "#/components/schemas/Meta", - "description": "Meta data passing to Shared View such as if download is allowed or not." - }, - "password": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Password to restrict access" - } - }, - "x-stoplight": { - "id": "0g3o2uo9y4h4g" - } - }, - "SignInReq": { - "description": "Model for Signin Request", - "examples": [ - { - "email": "user@example.com", - "password": "string" - } - ], - "properties": { - "email": { - "description": "Email address of the user", - "format": "email", - "type": "string" - }, - "password": { - "description": "Password of the user", - "type": "string" - } - }, - "required": ["email", "password"], - "title": "Signin Request Model", - "type": "object", - "x-stoplight": { - "id": "dxxafjky40cz1" - } - }, - "SignUpReq": { - "description": "Model for Signup Request", - "examples": [ - { - "email": "user@example.com", - "password": "password123456789", - "firstname": "Alice", - "lastname": "Smith", - "token": null, - "ignore_subscribe": 0 - } - ], - "title": "Signup Request Model", - "type": "object", - "properties": { - "email": { - "description": "Email address of the user", - "example": "user@example.com", - "format": "email", - "type": "string" - }, - "password": { - "description": "Password of the user", - "example": "password123456789", - "minLength": 8, - "type": "string" - }, - "firstname": { - "$ref": "#/components/schemas/StringOrNull", - "x-stoplight": { - "id": "lblivgs8wcsm1" - } - }, - "lastname": { - "$ref": "#/components/schemas/StringOrNull", - "x-stoplight": { - "id": "d4341r35tucq3" - } - }, - "token": { - "$ref": "#/components/schemas/StringOrNull", - "x-stoplight": { - "id": "otw9jgnr9n7c4" - }, - "description": "Sign Up Token. Used for invitation." - }, - "ignore_subscribe": { - "$ref": "#/components/schemas/Bool", - "x-stoplight": { - "id": "g7ge6mc6vdsds" - }, - "description": "Ignore Subscription" - } - }, - "required": ["email", "password"], - "x-stoplight": { - "id": "2rcbk0flkc4yu" - } - }, - "Sort": { - "description": "Model for Sort", - "examples": [ - { - "id": "so_xd4t51uv60ghzl", - "fk_column_id": "cl_l11b769pe2j1ce", - "fk_model_id": "md_ehn5izr99m7d45", - "base_id": "ds_3l9qx8xqksenrl", - "direction": "desc", - "order": 1, - "project_id": "p_9sx43moxhqtjm3" - } - ], - "title": "Sort Model", - "type": "object", - "properties": { - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "fk_column_id": { - "$ref": "#/components/schemas/Id" - }, - "fk_model_id": { - "$ref": "#/components/schemas/Id" - }, - "base_id": { - "type": "string", - "description": "Base ID", - "example": "ds_3l9qx8xqksenrl", - "readOnly": true - }, - "direction": { - "type": "string", - "description": "Sort direction", - "enum": ["asc", "desc"], - "example": "desc" - }, - "order": { - "type": "number", - "example": 1 - }, - "project_id": { - "type": "string", - "description": "Project ID", - "example": "p_9sx43moxhqtjm3", - "readOnly": true - } - }, - "x-stoplight": { - "id": "3jjbe2mjzy5li" - } - }, - "SortList": { - "description": "Model for Sort List", - "examples": [ - { - "list": [ - { - "id": "so_xd4t51uv60ghzl", - "fk_column_id": "cl_l11b769pe2j1ce", - "fk_model_id": "md_ehn5izr99m7d45", - "base_id": "ds_3l9qx8xqksenrl", - "direction": "desc", - "order": 1, - "project_id": "p_9sx43moxhqtjm3" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - ], - "title": "Sort List Model", - "type": "object", - "x-examples": { - "example-1": { - "bases": { - "list": [ - { - "alias": "string", - "database": "string", - "host": "string", - "id": "string", - "params": "string", - "password": "string", - "port": 0, - "project_id": "string", - "ssl": "string", - "type": "string", - "url": "string", - "username": "string" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "pageSize": 0, - "sort": "string", - "totalRows": 0 - } - } - } - }, - "properties": { - "list": { - "type": "array", - "x-stoplight": { - "id": "gjqqc8ciqg947" - }, - "description": "List of Sort Objects", - "items": { - "$ref": "#/components/schemas/Sort", - "x-stoplight": { - "id": "usnfa1kbovpmb" - } - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated", - "x-stoplight": { - "id": "i75wcejfp5mnq" - } - } - }, - "required": ["list", "pageInfo"], - "x-stoplight": { - "id": "fsq6d3pi8b3iz" - } - }, - "SortReq": { - "description": "Model for Sort Request", - "examples": [ - { - "direction": "asc", - "fk_column_id": "cl_l11b769pe2j1ce" - } - ], - "minProperties": 1, - "title": "Sort Request Model", - "type": "object", - "properties": { - "fk_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Column" - }, - "direction": { - "description": "Sort direction", - "enum": ["asc", "desc"], - "type": "string" - } - }, - "x-stoplight": { - "id": "lao7jfow2dbe7" - } - }, - "StringOrNull": { - "description": "Model for StringOrNull", - "examples": ["string"], - "oneOf": [ - { - "maxLength": 255, - "type": "string" - }, - { - "type": "null" - } - ], - "title": "StringOrNull Model", - "x-stoplight": { - "id": "xh9dwrizrvfh6" - } - }, - "Table": { - "description": "Model for Table", - "examples": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "columns": [ - { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": "CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP", - "clen": null, - "column_name": "updated_at", - "cop": "4", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "timestamp", - "deleted": null, - "dt": "timestamp", - "dtx": "specificType", - "dtxp": "0", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_m4wkaqgqqjzoeh", - "meta": null, - "np": null, - "ns": null, - "order": 4, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 0, - "system": 0, - "title": "UpdatedAt", - "uidt": "DateTime", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": "CURRENT_TIMESTAMP", - "clen": null, - "column_name": "created_at", - "cop": "3", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "timestamp", - "deleted": null, - "dt": "timestamp", - "dtx": "specificType", - "dtxp": "0", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_jpl0qu4gj4rexq", - "meta": null, - "np": null, - "ns": null, - "order": 3, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 0, - "system": 0, - "title": "CreatedAt", - "uidt": "DateTime", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": null, - "clen": "45", - "column_name": "title", - "cop": "2", - "created_at": "2023-03-02 17:04:06", - "csn": "utf8mb4", - "ct": "varchar(45)", - "deleted": null, - "dt": "varchar", - "dtx": "specificType", - "dtxp": "45", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_c5knoi4xs4sfpt", - "meta": null, - "np": null, - "ns": null, - "order": 2, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": 1, - "rqd": 0, - "system": 0, - "title": "Title", - "uidt": "SingleLineText", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - { - "ai": 1, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": null, - "clen": null, - "column_name": "id", - "cop": "1", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "int unsigned", - "deleted": null, - "dt": "int", - "dtx": "specificType", - "dtxp": "", - "dtxs": "0", - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_phvuuwjrzcdo0g", - "meta": null, - "np": "10", - "ns": "0", - "order": 1, - "pk": 1, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 1, - "system": 0, - "title": "Id", - "uidt": "ID", - "un": 1, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - } - ], - "columnsById": { - "cl_c5knoi4xs4sfpt": { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": null, - "clen": "45", - "column_name": "title", - "cop": "2", - "created_at": "2023-03-02 17:04:06", - "csn": "utf8mb4", - "ct": "varchar(45)", - "deleted": null, - "dt": "varchar", - "dtx": "specificType", - "dtxp": "45", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_c5knoi4xs4sfpt", - "meta": null, - "np": null, - "ns": null, - "order": 2, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": 1, - "rqd": 0, - "system": 0, - "title": "Title", - "uidt": "SingleLineText", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - "cl_jpl0qu4gj4rexq": { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": "CURRENT_TIMESTAMP", - "clen": null, - "column_name": "created_at", - "cop": "3", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "timestamp", - "deleted": null, - "dt": "timestamp", - "dtx": "specificType", - "dtxp": "0", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_jpl0qu4gj4rexq", - "meta": null, - "np": null, - "ns": null, - "order": 3, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 0, - "system": 0, - "title": "CreatedAt", - "uidt": "DateTime", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - "cl_m4wkaqgqqjzoeh": { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": "CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP", - "clen": null, - "column_name": "updated_at", - "cop": "4", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "timestamp", - "deleted": null, - "dt": "timestamp", - "dtx": "specificType", - "dtxp": "0", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_m4wkaqgqqjzoeh", - "meta": null, - "np": null, - "ns": null, - "order": 4, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 0, - "system": 0, - "title": "UpdatedAt", - "uidt": "DateTime", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - "cl_phvuuwjrzcdo0g": { - "ai": 1, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": null, - "clen": null, - "column_name": "id", - "cop": "1", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "int unsigned", - "deleted": null, - "dt": "int", - "dtx": "specificType", - "dtxp": "", - "dtxs": "0", - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_phvuuwjrzcdo0g", - "meta": null, - "np": "10", - "ns": "0", - "order": 1, - "pk": 1, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 1, - "system": 0, - "title": "Id", - "uidt": "ID", - "un": 1, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - } - }, - "created_at": "2023-03-02 17:04:06", - "deleted": null, - "enabled": 1, - "id": "md_rsu68aqjsbyqtl", - "meta": null, - "mm": 0, - "order": 1, - "pinned": null, - "project_id": "p_xm3thidrblw4n7", - "schema": null, - "table_name": "nc_vm5q___Table1", - "tags": null, - "title": "Table1", - "type": "table", - "updated_at": "2023-03-02 17:04:08", - "views": [ - { - "_ptn": "Table1", - "_tn": "Table1", - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:04:06", - "disabled": { - "commenter": false, - "creator": false, - "editor": false, - "guest": false, - "owner": false, - "viewer": false - }, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "vw_p2jcatxz4mvcfw", - "is_default": 1, - "lock_type": "collaborative", - "meta": {}, - "order": 1, - "password": null, - "project_id": "p_xm3thidrblw4n7", - "ptn": "nc_vm5q___Table1", - "ptype": "table", - "show": 1, - "show_system_fields": null, - "table_meta": null, - "title": "Table1", - "tn": "Table1", - "type": 3, - "updated_at": "2023-03-02 17:04:06", - "uuid": null, - "view": { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:04:06", - "fk_view_id": "vw_p2jcatxz4mvcfw", - "meta": null, - "project_id": "p_xm3thidrblw4n7", - "row_height": null, - "updated_at": "2023-03-02 17:04:06", - "uuid": null - } - } - ] - } - ], - "title": "Table Model", - "type": "object", - "properties": { - "base_id": { - "description": "Unique Base ID", - "type": "string" - }, - "columns": { - "description": "The columns included in this table", - "type": "array", - "items": { - "$ref": "#/components/schemas/Column" - } - }, - "columnsById": { - "description": "Column Models grouped by IDs", - "type": "object" - }, - "deleted": { - "$ref": "#/components/schemas/Bool" - }, - "enabled": { - "$ref": "#/components/schemas/Bool", - "description": "Is this table enabled?" - }, - "id": { - "description": "Unique Table ID", - "type": "string" - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "description": "Meta Data" - }, - "mm": { - "$ref": "#/components/schemas/Bool", - "description": "Is this table used for M2M" - }, - "order": { - "description": "The order of the list of tables", - "type": "number" - }, - "pinned": { - "$ref": "#/components/schemas/Bool", - "description": "Currently not in use" - }, - "project_id": { - "description": "Unique Project ID", - "type": "string" - }, - "table_name": { - "description": "Table Name. Prefix will be added for XCDB projects.", - "type": "string" - }, - "tags": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Currently not in use" - }, - "title": { - "description": "Table Title", - "type": "string" - }, - "type": { - "description": "Table Type", - "type": "string" - } - }, - "required": ["table_name", "title"], - "x-stoplight": { - "id": "rvdu5okgpz1xk" - } - }, - "TableList": { - "description": "Model for Table List", - "examples": [ - { - "list": [ - { - "alias": "string", - "base_id": "string", - "column": [ - { - "alias": "string", - "auto_increment": true, - "auto_update_timestamp": true, - "base_id": "string", - "character_maximum_length": "string", - "character_set_name": "string", - "colOptions": { - "deleted": "string", - "dr": "string", - "fk_child_column_id": "string", - "fk_column_id": "string", - "fk_index_name": "string", - "fk_mm_child_column_id": "string", - "fk_mm_model_id": "string", - "fk_mm_parent_column_id": "string", - "fk_parent_column_id": "string", - "id": "string", - "order": "string", - "type": "string", - "ur": "string", - "virtual": true - }, - "column_comment": "string", - "column_default": "string", - "column_ordinal_position": "string", - "column_type": "string", - "data_type": "string", - "data_type_x": "string", - "data_type_x_precision": "string", - "data_type_x_scale": "string", - "deleted": true, - "fk_model_id": "string", - "id": "string", - "numeric_precision": "string", - "numeric_scale": "string", - "order": 0, - "primary_key": true, - "primary_value": true, - "rqd": "string", - "title": "string", - "ui_data_type": "string", - "un": "string", - "unique": true, - "visible": true - } - ], - "columnByIds": {}, - "deleted": true, - "enabled": true, - "id": "string", - "order": 0, - "parent_id": "string", - "pinned": true, - "project_id": "string", - "show_as": "string", - "tags": "string", - "title": "string", - "type": "string" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - ], - "title": "Table List Model", - "type": "object", - "x-examples": { - "example-1": { - "bases": { - "list": [ - { - "alias": "string", - "database": "string", - "host": "string", - "id": "string", - "params": "string", - "password": "string", - "port": 0, - "project_id": "string", - "ssl": "string", - "type": "string", - "url": "string", - "username": "string" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "pageSize": 0, - "sort": "string", - "totalRows": 0 - } - } - } - }, - "properties": { - "list": { - "minItems": 1, - "type": "array", - "uniqueItems": true, - "description": "List of table objects", - "items": { - "$ref": "#/components/schemas/Table" - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated", - "description": "Paginated Info" - } - }, - "required": ["list", "pageInfo"], - "x-stoplight": { - "id": "25z7dodhqs3lc" - } - }, - "TableReq": { - "description": "Model for Table Request", - "examples": [ - { - "columns": [ - { - "ai": false, - "altered": 1, - "cdf": "CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP", - "ck": false, - "clen": 45, - "column_name": "updated_at", - "ct": "varchar(45)", - "dt": "timestamp", - "dtx": "specificType", - "dtxp": "", - "dtxs": "", - "np": null, - "nrqd": true, - "ns": null, - "pk": false, - "rqd": false, - "title": "UpdatedAt", - "uicn": "", - "uidt": "DateTime", - "uip": "", - "un": false - }, - { - "ai": false, - "altered": 1, - "cdf": "CURRENT_TIMESTAMP", - "ck": false, - "clen": 45, - "column_name": "created_at", - "ct": "varchar(45)", - "dt": "timestamp", - "dtx": "specificType", - "dtxp": "", - "dtxs": "", - "np": null, - "nrqd": true, - "ns": null, - "pk": false, - "rqd": false, - "title": "CreatedAt", - "uicn": "", - "uidt": "DateTime", - "uip": "", - "un": false - }, - { - "ai": false, - "altered": 1, - "cdf": null, - "ck": false, - "clen": 45, - "column_name": "title", - "ct": "varchar(45)", - "dt": "varchar", - "dtx": "specificType", - "dtxp": "45", - "dtxs": "", - "np": null, - "nrqd": true, - "ns": null, - "pk": false, - "rqd": false, - "title": "Title", - "uicn": "", - "uidt": "SingleLineText", - "uip": "", - "un": false - }, - { - "ai": true, - "altered": 1, - "cdf": null, - "ck": false, - "clen": null, - "column_name": "id", - "ct": "int(11)", - "dt": "int", - "dtx": "integer", - "dtxp": "11", - "dtxs": "", - "np": 11, - "nrqd": false, - "ns": 0, - "pk": true, - "rqd": true, - "title": "Id", - "uicn": "", - "uidt": "ID", - "uip": "", - "un": true - } - ], - "table_name": "Sheet-1", - "title": "Sheet-1" - } - ], - "properties": { - "columns": { - "description": "The column models in this table", - "items": { - "$ref": "#/components/schemas/NormalColumnRequest" - }, - "type": "array" - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "description": "the meta data for this table" - }, - "order": { - "description": "The order of table list", - "example": 1, - "type": "number" - }, - "table_name": { - "description": "Table name", - "example": "my_table", - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "title": { - "description": "Table title", - "example": "My Table", - "maxLength": 255, - "minLength": 0, - "type": "string" - } - }, - "required": ["columns", "table_name"], - "title": "Table Request Model", - "type": "object", - "x-stoplight": { - "id": "kilqakhuuzstv" - } - }, - "User": { - "description": "Model for User", - "examples": [ - { - "email": "user@example.com", - "email_verified": true, - "firstname": "Alice", - "id": "us_8kugj628ebjngs", - "lastname": "Smith", - "roles": "org-level-viewer" - } - ], - "title": "User Model", - "type": "object", - "x-internal": false, - "properties": { - "email": { - "description": "The email of the user", - "example": "user@example.com", - "format": "email", - "type": "string" - }, - "email_verified": { - "description": "Set to true if the user's email has been verified.", - "type": "boolean" - }, - "firstname": { - "description": "The first name of the user", - "example": "Alice", - "type": "string" - }, - "id": { - "description": "Unique identifier for the given user.", - "example": "us_8kugj628ebjngs", - "type": "string" - }, - "lastname": { - "description": "The last name of the user", - "example": "Smith", - "type": "string" - }, - "roles": { - "description": "The roles of the user", - "example": "org-level-viewer", - "type": "string" - } - }, - "required": ["email", "email_verified", "firstname", "id", "lastname"], - "x-stoplight": { - "id": "nwug6wvbc5yrp" - } - }, - "UserInfo": { - "description": "Model for User Info", - "examples": [ - { - "email": "user@example.com", - "email_verified": true, - "firstname": "string", - "id": "string", - "lastname": "string", - "roles": null - } - ], - "properties": { - "email": { - "description": "User Email", - "format": "email", - "type": "string" - }, - "email_verified": { - "description": "Set to true if the user's email has been verified.", - "type": "boolean" - }, - "firstname": { - "description": "The firstname of the user", - "type": "string" - }, - "id": { - "description": "User ID", - "type": "string" - }, - "lastname": { - "description": "The lastname of the user", - "type": "string" - }, - "roles": { - "description": "The roles of the user" - } - }, - "title": "User Info Model", - "type": "object", - "x-stoplight": { - "id": "qravubcoxvr6x" - } - }, - "UserList": { - "description": "Model for User List", - "examples": [ - { - "list": [ - { - "email": "user@example.com", - "email_verified": true, - "firstname": "Alice", - "id": "us_8kugj628ebjngs", - "lastname": "Smith", - "roles": "org-level-viewer" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - ], - "title": "User List Model", - "type": "object", - "x-examples": { - "example-1": { - "bases": { - "list": [ - { - "alias": "string", - "database": "string", - "host": "string", - "id": "string", - "params": "string", - "password": "string", - "port": 0, - "project_id": "string", - "ssl": "string", - "type": "string", - "url": "string", - "username": "string" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "pageSize": 0, - "sort": "string", - "totalRows": 0 - } - } - } - }, - "properties": { - "list": { - "type": "array", - "x-stoplight": { - "id": "8o7v47q3e67ef" - }, - "description": "List of user objects", - "items": { - "$ref": "#/components/schemas/User", - "x-stoplight": { - "id": "kwqzxwea9r5er" - } - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated", - "x-stoplight": { - "id": "0d98n6sfxfvft" - }, - "description": "Paginated Info" - } - }, - "required": ["list", "pageInfo"], - "x-stoplight": { - "id": "11epslmm9jcga" - } - }, - "View": { - "description": "Model for View", - "examples": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:46:31", - "fk_model_id": "md_mhs9z4r2ak98x0", - "id": "vw_lg052cnc1c26kf", - "is_default": 1, - "lock_type": "collaborative", - "meta": {}, - "order": 1, - "password": null, - "project_id": "p_xm3thidrblw4n7", - "show": 1, - "show_system_fields": null, - "title": "Sheet-1", - "type": 3, - "updated_at": "2023-03-02 17:46:31", - "uuid": null, - "view": { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:46:31", - "fk_view_id": "vw_lg052cnc1c26kf", - "meta": null, - "project_id": "p_xm3thidrblw4n7", - "row_height": null, - "updated_at": "2023-03-02 17:46:31", - "uuid": null - } - } - ], - "title": "View Model", - "type": "object", - "properties": { - "base_id": { - "$ref": "#/components/schemas/Id", - "description": "Unique Base ID" - }, - "fk_model_id": { - "$ref": "#/components/schemas/Id", - "description": "Unique Model ID" - }, - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID for View" - }, - "lock_type": { - "description": "Lock Type of the view", - "enum": ["collaborative", "locked", "personal"], - "type": "string" - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "description": "Meta data for this view" - }, - "order": { - "description": "The rder of the list of views", - "type": "number" - }, - "password": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Password for protecting the view" - }, - "project_id": { - "$ref": "#/components/schemas/Id", - "description": "Unique Project ID" - }, - "show": { - "$ref": "#/components/schemas/Bool", - "description": "If this view is shown?" - }, - "show_system_fields": { - "$ref": "#/components/schemas/Bool", - "description": "Should show system fields in this view?" - }, - "is_default": { - "$ref": "#/components/schemas/Bool", - "description": "Is this view default view for the model?" - }, - "title": { - "description": "View Title", - "type": "string" - }, - "type": { - "description": "View Type", - "type": "number" - }, - "uuid": { - "$ref": "#/components/schemas/StringOrNull", - "description": "UUID of the view" - }, - "view": { - "anyOf": [ - { - "$ref": "#/components/schemas/Form" - }, - { - "$ref": "#/components/schemas/Gallery" - }, - { - "$ref": "#/components/schemas/Grid" - }, - { - "$ref": "#/components/schemas/Kanban" - }, - { - "$ref": "#/components/schemas/Map" - } - ], - "description": "Associated View Model" - } - }, - "required": ["fk_model_id", "show", "title", "type"], - "x-stoplight": { - "id": "pbahdgaroikdz" - } - }, - "ViewList": { - "description": "Model for View List", - "examples": [ - { - "list": [ - { - "alias": "string", - "column": [ - { - "alias": "string", - "auto_increment": true, - "auto_update_timestamp": true, - "base_id": "string", - "character_maximum_length": "string", - "character_set_name": "string", - "colOptions": { - "deleted": "string", - "dr": "string", - "fk_child_column_id": "string", - "fk_column_id": "string", - "fk_index_name": "string", - "fk_mm_child_column_id": "string", - "fk_mm_model_id": "string", - "fk_mm_parent_column_id": "string", - "fk_parent_column_id": "string", - "id": "string", - "order": "string", - "type": "string", - "ur": "string", - "virtual": true - }, - "column_comment": "string", - "column_default": "string", - "column_ordinal_position": "string", - "column_type": "string", - "data_type": "string", - "data_type_x": "string", - "data_type_x_precision": "string", - "data_type_x_scale": "string", - "deleted": true, - "fk_model_id": "string", - "id": "string", - "numeric_precision": "string", - "numeric_scale": "string", - "order": 0, - "primary_key": true, - "primary_value": true, - "rqd": "string", - "title": "string", - "ui_data_type": "string", - "un": "string", - "unique": true, - "visible": true - } - ], - "columnByIds": {}, - "deleted": true, - "enabled": true, - "fk_base_id": "string", - "fk_project_id": "string", - "id": "string", - "order": 0, - "parent_id": "string", - "pinned": true, - "show_as": "string", - "tags": "string", - "title": "string", - "type": "string" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - ], - "title": "View List Model", - "type": "object", - "x-examples": { - "example-1": { - "bases": { - "list": [ - { - "alias": "string", - "database": "string", - "host": "string", - "id": "string", - "params": "string", - "password": "string", - "port": 0, - "project_id": "string", - "ssl": "string", - "type": "string", - "url": "string", - "username": "string" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "pageSize": 0, - "sort": "string", - "totalRows": 0 - } - } - } - }, - "properties": { - "list": { - "type": "array", - "description": "List of view objects", - "items": { - "$ref": "#/components/schemas/View" - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated", - "description": "Paginated Info" - } - }, - "required": ["list", "pageInfo"], - "x-stoplight": { - "id": "5wwtppugkhbeh" - } - }, - "ViewCreateReq": { - "type": "object", - "x-stoplight": { - "id": "lksv99846uy60" - }, - "title": "ViewCreateReq", - "description": "Model for View Create Request", - "examples": [ - { - "title": "My Grid View", - "type": 3, - "copy_from_id": null, - "fk_grp_col_id": null, - "fk_geo_data_col_id": null - }, - { - "title": "My Gallery View", - "type": 2, - "copy_from_id": null, - "fk_grp_col_id": null, - "fk_geo_data_col_id": null - }, - { - "title": "My Form View", - "type": 1, - "copy_from_id": null, - "fk_grp_col_id": null, - "fk_geo_data_col_id": null - }, - { - "title": "My Kanban View", - "type": 4, - "copy_from_id": null, - "fk_grp_col_id": "cl_g0a89q9xdry3lu", - "fk_geo_data_col_id": null - }, - { - "title": "My Map View", - "type": 5, - "copy_from_id": null, - "fk_grp_col_id": null, - "fk_geo_data_col_id": "cl_uu1meolj00tlrq" - } - ], - "properties": { - "title": { - "type": "string", - "description": "View Title", - "example": "My View" - }, - "type": { - "type": "number", - "description": "View Type" - }, - "copy_from_id": { - "$ref": "#/components/schemas/StringOrNull", - "description": "ID of view to be copied from. Used in Copy View." - }, - "fk_grp_col_id": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Foreign Key to Grouping Column. Used in creating Kanban View." - }, - "fk_geo_data_col_id": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Foreign Key to Geo Data Column. Used in creating Map View." - } - }, - "required": ["title"] - }, - "ViewUpdateReq": { - "description": "Model for View Update Request", - "x-stoplight": { - "id": "1enlswadfc6p5" - }, - "examples": [ - { - "title": "Grid View 1", - "uuid": "e2457bbf-e29c-4fec-866e-fe3b01dba57f", - "password": "password123", - "lock_type": "collaborative", - "meta": "{\"allowCSVDownload\":true}", - "order": 1, - "show_system_fields": 0 - } - ], - "title": "View Update Request Model", - "type": "object", - "properties": { - "title": { - "maxLength": 255, - "type": "string", - "description": "View Title", - "example": "Grid View 1" - }, - "uuid": { - "maxLength": 255, - "type": "string", - "x-stoplight": { - "id": "vlhs7xs644u8l" - }, - "description": "View UUID. Used in Shared View.", - "example": "e2457bbf-e29c-4fec-866e-fe3b01dba57f" - }, - "password": { - "maxLength": 255, - "type": "string", - "x-stoplight": { - "id": "vlhs7xs644u8l" - }, - "description": "View Password. Used in Shared View.", - "example": "password123" - }, - "lock_type": { - "enum": ["collaborative", "locked", "personal"], - "type": "string", - "description": "Lock type of View.", - "example": "collaborative" - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "description": "Meta info used in View." - }, - "order": { - "type": "number", - "description": "The order of the list of views.", - "example": 1, - "minimum": 0 - }, - "show_system_fields": { - "$ref": "#/components/schemas/Bool", - "description": "Should this view show system fields?" - } - } - }, - "ViewColumnUpdateReq": { - "description": "Model for View Column Update Request", - "x-stoplight": { - "id": "ifzuv29axterb" - }, - "examples": [ - { - "show": 0, - "order": 1 - } - ], - "title": "View Column Update Request Model", - "type": "object", - "properties": { - "show": { - "$ref": "#/components/schemas/Bool", - "description": "View Title", - "x-stoplight": { - "id": "coxius73ejq5x" - } - }, - "order": { - "type": "number", - "description": "The order of the list of views.", - "example": 1, - "minimum": 0 - } - } - }, - "ViewColumnReq": { - "description": "Model for View Column Request", - "x-stoplight": { - "id": "z4bq84nyqkhd8" - }, - "examples": [ - { - "fk_column_id": "cl_5jestblzneb649", - "show": 0, - "order": 1 - } - ], - "title": "View Column Request Model", - "type": "object", - "properties": { - "fk_column_id": { - "$ref": "#/components/schemas/Id", - "x-stoplight": { - "id": "rxd07wvp9hf6s" - }, - "description": "Foreign Key to Column" - }, - "show": { - "$ref": "#/components/schemas/Bool", - "description": "View Title", - "x-stoplight": { - "id": "coxius73ejq5x" - } - }, - "order": { - "type": "number", - "description": "The order of the list of views.", - "example": 1, - "minimum": 0 - } - } - }, - "VisibilityRuleReq": { - "description": "Model for Visibility Rule Request", - "examples": [ - [ - { - "disabled": { - "commenter": true, - "creator": true, - "editor": true, - "guest": true, - "owner": true, - "viewer": true - } - } - ] - ], - "items": { - "properties": { - "id": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "disabled": { - "properties": { - "commenter": { - "$ref": "#/components/schemas/Bool" - }, - "creator": { - "$ref": "#/components/schemas/Bool" - }, - "editor": { - "$ref": "#/components/schemas/Bool" - }, - "guest": { - "$ref": "#/components/schemas/Bool" - }, - "owner": { - "$ref": "#/components/schemas/Bool" - }, - "viewer": { - "$ref": "#/components/schemas/Bool" - } - }, - "type": "object" - } - }, - "type": "object" - }, - "title": "Visibility Rule Request Model", - "type": "array", - "x-stoplight": { - "id": "vuo5q4vwtarx8" - } - } - }, - "responses": { - "ProjectList": { - "description": "Example response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProjectList" - }, - "examples": { - "example-1": { - "value": { - "list": [ - { - "bases": [ - { - "alias": "string", - "config": null, - "created_at": "2023-03-01 14:27:36", - "enabled": true, - "id": "string", - "inflection_column": "camelize", - "inflection_table": "camelize", - "is_meta": true, - "order": 1, - "project_id": "string", - "type": "mysql2", - "updated_at": "2023-03-01 14:27:36" - } - ], - "color": "#24716E", - "created_at": "2023-03-01 14:27:36", - "deleted": true, - "description": "This is my project description", - "id": "p_124hhlkbeasewh", - "is_meta": true, - "meta": {}, - "order": 0, - "prefix": "nc_vm5q__", - "status": "string", - "title": "my-project", - "updated_at": "2023-03-01 14:27:36" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "BaseList": { - "description": "Example response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BaseList" - }, - "examples": { - "example-1": { - "value": { - "list": [ - { - "id": "ds_krsappzu9f8vmo", - "project_id": "p_01clqvzik3izk6", - "alias": null, - "config": "", - "meta": null, - "is_meta": 1, - "type": "mysql2", - "inflection_column": "camelize", - "inflection_table": "camelize", - "created_at": "2023-03-01 16:31:49", - "updated_at": "2023-03-02 11:28:17", - "enabled": 1, - "order": 1 - }, - { - "id": "ds_btbdt19zde0gj9", - "project_id": "p_01clqvzik3izk6", - "alias": "sakila", - "config": "", - "meta": null, - "is_meta": null, - "type": "mysql2", - "inflection_column": "camelize", - "inflection_table": "camelize", - "created_at": "2023-03-02 11:28:17", - "updated_at": "2023-03-02 11:28:17", - "enabled": 1, - "order": 2 - } - ], - "pageInfo": { - "totalRows": 2, - "page": 1, - "pageSize": 2, - "isFirstPage": true, - "isLastPage": true - } - } - } - } - } - } - }, - "TableList": { - "description": "Example response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TableList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "id": "md_5hua2iqloqirhd", - "base_id": "ds_jxuewivwbxeum2", - "project_id": "p_tbhl1hnycvhe5l", - "table_name": "nc_b84e___Sheet-1", - "title": "Sheet-1", - "type": "table", - "meta": null, - "schema": null, - "enabled": true, - "mm": false, - "tags": null, - "pinned": null, - "deleted": null, - "order": 1, - "created_at": "2023-03-11T09:11:45.907Z", - "updated_at": "2023-03-11T09:11:45.907Z" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "ColumnList": { - "description": "Example response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ColumnList" - } - } - } - }, - "FilterList": { - "description": "Example response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FilterList" - } - } - } - }, - "SortList": { - "description": "Example response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SortList" - }, - "examples": {} - } - } - }, - "ViewList": { - "description": "Example response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ViewList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "alias": "string", - "column": [ - { - "alias": "string", - "auto_increment": true, - "auto_update_timestamp": true, - "base_id": "string", - "character_maximum_length": "string", - "character_set_name": "string", - "colOptions": { - "deleted": "string", - "dr": "string", - "fk_child_column_id": "string", - "fk_column_id": "string", - "fk_index_name": "string", - "fk_mm_child_column_id": "string", - "fk_mm_model_id": "string", - "fk_mm_parent_column_id": "string", - "fk_parent_column_id": "string", - "id": "string", - "order": "string", - "type": "string", - "ur": "string", - "virtual": true - }, - "column_comment": "string", - "column_default": "string", - "column_ordinal_position": "string", - "column_type": "string", - "data_type": "string", - "data_type_x": "string", - "data_type_x_precision": "string", - "data_type_x_scale": "string", - "deleted": true, - "fk_model_id": "string", - "id": "string", - "numeric_precision": "string", - "numeric_scale": "string", - "order": 0, - "primary_key": true, - "primary_value": true, - "rqd": "string", - "title": "string", - "ui_data_type": "string", - "un": "string", - "unique": true, - "visible": true - } - ], - "columnByIds": {}, - "deleted": true, - "enabled": true, - "fk_base_id": "string", - "fk_project_id": "string", - "id": "string", - "order": 0, - "parent_id": "string", - "pinned": true, - "show_as": "string", - "tags": "string", - "title": "string", - "type": "string" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "SharedViewList": { - "description": "Example response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SharedViewList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:46:31", - "fk_model_id": "md_mhs9z4r2ak98x0", - "id": "vw_lg052cnc1c26kf", - "is_default": 1, - "lock_type": "collaborative", - "meta": {}, - "order": 1, - "password": null, - "project_id": "p_xm3thidrblw4n7", - "show": 1, - "show_system_fields": null, - "title": "Sheet-1", - "type": 3, - "updated_at": "2023-03-02 17:46:31", - "uuid": null, - "view": { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:46:31", - "fk_view_id": "vw_lg052cnc1c26kf", - "meta": null, - "project_id": "p_xm3thidrblw4n7", - "row_height": null, - "updated_at": "2023-03-02 17:46:31", - "uuid": null - } - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "HookList": { - "description": "Example response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HookList" - } - } - } - }, - "UserList": { - "description": "Example response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UserList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "email": "user@example.com", - "email_verified": true, - "firstname": "Alice", - "id": "us_8kugj628ebjngs", - "lastname": "Smith", - "roles": "org-level-viewer" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "APITokenList": { - "description": "Example response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiTokenList" - }, - "examples": {} - } - }, - "type": "object", - "properties": { - "list": { - "type": "array", - "x-stoplight": { - "id": "uukp6v55zfp7i" - }, - "items": { - "$ref": "#/components/schemas/ApiToken", - "x-stoplight": { - "id": "9zqpoqfkdxy0y" - } - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated", - "x-stoplight": { - "id": "6unr17jyisial" - } - } - } - }, - "BadRequest": { - "description": "BadReqeust", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "p9mk4oi0hbihm" - }, - "example": "BadRequest [Error]: " - } - }, - "required": ["msg"] - }, - "examples": { - "Example 1": { - "value": { - "msg": "BadRequest [Error]: " - } - } - } - } - }, - "headers": {} - } - }, - "securitySchemes": { - "xc-auth": { - "name": "Auth Token ", - "type": "apiKey", - "in": "header", - "description": "Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable `NC_JWT_EXPIRES_IN`." - }, - "xc-shared-base-id": { - "name": "Shared Base ID", - "type": "apiKey", - "in": "header", - "description": "Shared base uuid" - } - }, - "parameters": { - "xc-auth": { - "name": "xc-auth", - "in": "header", - "required": false, - "schema": { - "type": "string" - }, - "description": "Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN." - } - } - } -}{ - "openapi": "3.1.0", - "info": { - "title": "nocodb", - "version": "1.0", - "description": "NocoDB API Documentation" - }, - "x-tagGroups": [ - { - "name": "Auth APIs", - "tags": ["Auth", "API Token"] - }, - { - "name": "Public APIs", - "tags": ["Public"] - }, - { - "name": "Data APIs", - "tags": ["DB Table Row", "DB View Row", "Storage"] - }, - { - "name": "Meta APIs", - "tags": [ - "Base", - "DB Table", - "DB Table Column", - "DB Table Filter", - "DB Table Sort", - "DB Table Webhook", - "DB Table Webhook Filter", - "DB View", - "DB View Column", - "DB View Share", - "Plugin", - "Project", - "Utils" - ] - }, - { - "name": "Organisation APIs", - "tags": ["Org App Settings", "Org License", "Org Tokens", "Org Users"] - } - ], - "servers": [ - { - "url": "http://localhost:8080" - } - ], - "paths": { - "/api/v1/auth/user/signup": { - "post": { - "summary": "Signup", - "operationId": "auth-signup", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "token": { - "type": "string", - "description": "The signed JWT token for information exchange", - "example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbWFpbCI6IndAbm9jb2RiLmNvbSIsImZpcnN0bmFtZSI6bnVsbCwibGFzdG5hbWUiOm51bGwsImlkIjoidXNfYjN4bzJpNDRueDV5OWwiLCJyb2xlcyI6Im9yZy1sZXZlbC1jcmVhdG9yLHN1cGVyIiwidG9rZW5fdmVyc2lvbiI6ImJmMTc3ZGUzYjk3YjAzMjY4YjU0NGZmMjMzNGU5YjFhMGUzYzgxM2NiYzliOTJkYWMwYmM5NTRiNmUzN2ZjMTJjYmFkNDM2NmIwYzExZTdjIiwiaWF0IjoxNjc4MDc4NDMyLCJleHAiOjE2NzgxMTQ0MzJ9.gzwp_svZlbA5PV_eawYV-9UFjZVjniy-tCDce16xrkI" - } - } - }, - "examples": { - "Example 1": { - "value": { - "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbWFpbCI6IndAbm9jb2RiLmNvbSIsImZpcnN0bmFtZSI6bnVsbCwibGFzdG5hbWUiOm51bGwsImlkIjoidXNfYjN4bzJpNDRueDV5OWwiLCJyb2xlcyI6Im9yZy1sZXZlbC1jcmVhdG9yLHN1cGVyIiwidG9rZW5fdmVyc2lvbiI6ImJmMTc3ZGUzYjk3YjAzMjY4YjU0NGZmMjMzNGU5YjFhMGUzYzgxM2NiYzliOTJkYWMwYmM5NTRiNmUzN2ZjMTJjYmFkNDM2NmIwYzExZTdjIiwiaWF0IjoxNjc4MDc4NDMyLCJleHAiOjE2NzgxMTQ0MzJ9.gzwp_svZlbA5PV_eawYV-9UFjZVjniy-tCDce16xrkI" - } - } - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string" - } - } - }, - "examples": { - "Invalid email": { - "value": { - "msg": "Invalid email" - } - }, - "Invalid invite url": { - "value": { - "msg": "Invalid invite url" - } - }, - "Expired invite url": { - "value": { - "msg": "Expired invite url, Please contact super admin to get a new invite url" - } - }, - "User already exist": { - "value": { - "msg": "User already exist" - } - }, - "Invite only signup": { - "value": { - "msg": "Not allowed to signup, contact super admin" - } - } - } - } - } - } - }, - "tags": ["Auth"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SignUpReq" - }, - "examples": { - "Example 1": { - "value": { - "email": "user@example.com", - "password": "password123456789", - "firstname": "Alice", - "lastname": "Smith", - "token": null, - "ignore_subscribe": 0 - } - } - } - } - } - }, - "description": "Create a new user with provided email and password and first user is marked as super admin. " - } - }, - "/api/v1/auth/user/signout": { - "post": { - "summary": "Signout", - "operationId": "auth-signout", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "description": "Success Message", - "example": "Signed out successfully" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "Signed out successfully" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Auth"], - "description": "Clear refresh token from the database and cookie." - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "/api/v1/auth/user/signin": { - "post": { - "summary": "Signin", - "operationId": "auth-signin", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "token": { - "type": "string", - "description": "The signed JWT token for information exchange", - "example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbWFpbCI6IndAbm9jb2RiLmNvbSIsImZpcnN0bmFtZSI6bnVsbCwibGFzdG5hbWUiOm51bGwsImlkIjoidXNfYjN4bzJpNDRueDV5OWwiLCJyb2xlcyI6Im9yZy1sZXZlbC1jcmVhdG9yLHN1cGVyIiwidG9rZW5fdmVyc2lvbiI6ImJmMTc3ZGUzYjk3YjAzMjY4YjU0NGZmMjMzNGU5YjFhMGUzYzgxM2NiYzliOTJkYWMwYmM5NTRiNmUzN2ZjMTJjYmFkNDM2NmIwYzExZTdjIiwiaWF0IjoxNjc4MDc4NDMyLCJleHAiOjE2NzgxMTQ0MzJ9.gzwp_svZlbA5PV_eawYV-9UFjZVjniy-tCDce16xrkI" - } - } - }, - "examples": { - "Example 1": { - "value": { - "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbWFpbCI6IndAbm9jb2RiLmNvbSIsImZpcnN0bmFtZSI6bnVsbCwibGFzdG5hbWUiOm51bGwsImlkIjoidXNfYjN4bzJpNDRueDV5OWwiLCJyb2xlcyI6Im9yZy1sZXZlbC1jcmVhdG9yLHN1cGVyIiwidG9rZW5fdmVyc2lvbiI6ImJmMTc3ZGUzYjk3YjAzMjY4YjU0NGZmMjMzNGU5YjFhMGUzYzgxM2NiYzliOTJkYWMwYmM5NTRiNmUzN2ZjMTJjYmFkNDM2NmIwYzExZTdjIiwiaWF0IjoxNjc4MDc4NDMyLCJleHAiOjE2NzgxMTQ0MzJ9.gzwp_svZlbA5PV_eawYV-9UFjZVjniy-tCDce16xrkI" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Auth"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SignInReq" - }, - "examples": { - "example-1": { - "value": { - "email": "user@example.com", - "password": "Password" - } - } - } - } - } - }, - "description": "Authenticate existing user with their email and password. Successful login will return a JWT access-token. " - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "/api/v1/auth/user/me": { - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "get": { - "summary": "Get User Info", - "operationId": "auth-me", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UserInfo" - }, - "examples": { - "example-1": { - "value": { - "id": "us_8kugj628ebjngs", - "email": "user@example.com", - "email_verified": true, - "firstname": "Alice", - "lastname": "Smith", - "roles": "org-level-viewer" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Auth"], - "description": "Returns authenticated user info", - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id" - }, - "in": "query", - "name": "project_id", - "description": "Pass project id to get project specific roles along with user info" - } - ] - } - }, - "/api/v1/auth/password/forgot": { - "post": { - "summary": "Forget Password", - "operationId": "auth-password-forgot", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "q9s5vh2i34x6c" - }, - "example": "Please check your email to reset the password", - "description": "Success Message" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "Please check your email to reset the password" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Emails user with a reset url.", - "tags": ["Auth"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PasswordForgotReq" - }, - "examples": { - "Example 1": { - "value": { - "email": "user@example.com" - } - } - } - } - }, - "description": "Pass registered user email id in request body" - } - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "/api/v1/auth/password/change": { - "post": { - "summary": "Change Password", - "operationId": "auth-password-change", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "description": "Success Message" - } - } - }, - "examples": { - "Success response": { - "value": { - "msg": "Password has been updated successfully" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Change password of authenticated user with a new one.", - "tags": ["Auth"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PasswordChangeReq" - }, - "examples": { - "example-1": { - "value": { - "currentPassword": "currentPassword", - "newPassword": "newPassword" - } - } - } - } - }, - "description": "Old password need to be passed along with new password for changing password." - } - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "/api/v1/auth/token/validate/{token}": { - "post": { - "summary": "Verify Reset Token", - "operationId": "auth-password-reset-token-validate", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "unxdsok22kg1y" - }, - "example": "Token has been validated successfully", - "description": "Success Message" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "Token has been validated successfully" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Validate password reset url token.", - "tags": ["Auth"], - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "parameters": [ - { - "schema": { - "type": "string", - "format": "uuid", - "example": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11" - }, - "name": "token", - "in": "path", - "required": true, - "description": "Reset Token" - } - ] - }, - "/api/v1/auth/email/validate/{token}": { - "post": { - "summary": "Verify Email", - "operationId": "auth-email-validate", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "u49sbr20s9rgf" - }, - "description": "Success Message", - "example": "Email has been verified successfully" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "Email has been verified successfully" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Api for verifying email where token need to be passed which is shared to user email.", - "tags": ["Auth"], - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "parameters": [ - { - "schema": { - "type": "string", - "format": "uuid", - "example": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11" - }, - "name": "token", - "in": "path", - "required": true, - "description": "Validation Token" - } - ] - }, - "/api/v1/auth/password/reset/{token}": { - "post": { - "summary": "Reset Password", - "operationId": "auth-password-reset", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "2to6ro4121rfx" - }, - "description": "Success Message", - "example": "Password has been reset successfully" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "Password has been reset successfully" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Update user password to new by using reset token.", - "tags": ["Auth"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PasswordResetReq" - }, - "examples": { - "Example 1": { - "value": { - "password": "newpassword" - } - } - } - } - } - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "parameters": [ - { - "schema": { - "type": "string", - "format": "uuid", - "example": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11" - }, - "name": "token", - "in": "path", - "required": true, - "description": "Reset Password Token" - } - ] - }, - "/api/v1/auth/token/refresh": { - "post": { - "summary": "Refresh Token", - "operationId": "auth-token-refresh", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "token": { - "type": "string", - "description": "New access token for user", - "example": "96751db2d53fb834382b682268874a2ea9ee610e4d904e688d1513f11d3c30d62d36d9e05dec0d63" - } - } - }, - "examples": { - "Example 1": { - "value": { - "token": "96751db2d53fb834382b682268874a2ea9ee610e4d904e688d1513f11d3c30d62d36d9e05dec0d63" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Regenerate user refresh token", - "tags": ["Auth"], - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "/api/v1/tokens": { - "get": { - "summary": "List Organisation API Tokens", - "operationId": "org-tokens-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiTokenList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "id": "1", - "fk_user_id": "us_b3xo2i44nx5y9l", - "description": "This API Token is for ABC application", - "token": "DYh540o8hbWpUGdarekECKLdN5OhlgCUWutVJYX2" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "List all organisation API tokens. Access with API tokens will be blocked.", - "tags": ["Org Tokens"], - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "post": { - "summary": "Create Organisation API Token", - "operationId": "org-tokens-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiToken" - }, - "examples": { - "Example 1": { - "value": { - "id": "1", - "fk_user_id": "us_b3xo2i44nx5y9l", - "description": "This API Token is for ABC application", - "token": "DYh540o8hbWpUGdarekECKLdN5OhlgCUWutVJYX2" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiTokenReq" - }, - "examples": { - "Example 1": { - "value": { - "description": "This API token is for ABC application" - } - } - } - } - } - }, - "tags": ["Org Tokens"], - "description": "Creat an organisation API token. Access with API tokens will be blocked." - } - }, - "/api/v1/tokens/{token}": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "token", - "in": "path", - "required": true, - "description": "API Token" - } - ], - "delete": { - "summary": "Delete Organisation API Tokens", - "operationId": "org-tokens-delete", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number", - "example": 1 - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Org Tokens"], - "description": "Delete an organisation API token. Access with API tokens will be blocked.", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/license": { - "get": { - "summary": "Get App License", - "operationId": "org-license-get", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Application license key" - } - } - }, - "examples": { - "Example 1": { - "value": { - "key": "195f7bcc-c3e1-43c5-b23c-8d8127280e7d" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Get the application license key. Exclusive for super admin.", - "tags": ["Org License"], - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "post": { - "summary": "Create App License", - "operationId": "org-license-set", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "wsiywigeb9hjl" - }, - "example": "The license key has been saved" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "The license key has been saved" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/LicenseReq" - }, - "examples": { - "Example 1": { - "value": { - "key": "1234567890" - } - } - } - } - } - }, - "tags": ["Org License"], - "description": "Set the application license key. Exclusive for super admin.", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/app-settings": { - "get": { - "summary": "Get App Settings", - "operationId": "org-app-settings-get", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "invite_only_signup": { - "type": "boolean", - "description": "Status of invite only signup", - "example": true - } - } - }, - "examples": { - "Example 1": { - "value": { - "invite_only_signup": true - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Get the application settings. Exclusive for super admin.", - "tags": ["Org App Settings"], - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "post": { - "summary": "Create App Settings", - "operationId": "org-app-settings-set", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "6qbh8ijtc4tva" - }, - "example": "The app settings have been saved" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "The app settings have been saved" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "invite_only_signup": { - "type": "boolean", - "description": "Status of invite only signup", - "example": true - } - } - }, - "examples": { - "Example 1": { - "value": { - "invite_only_signup": true - } - } - } - } - } - }, - "tags": ["Org App Settings"], - "description": "Update the application settings. Exclusive for super admin.", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/users": { - "get": { - "summary": "List Organisation Users", - "operationId": "org-users-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UserList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "email": "user@example.com", - "email_verified": true, - "firstname": "Alice", - "id": "us_8kugj628ebjngs", - "lastname": "Smith", - "roles": "org-level-viewer" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "List all organisation users. Exclusive for Super Admin. Access with API Tokens will be blocked.", - "tags": ["Org Users"], - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "post": { - "summary": "Create Organisation User", - "operationId": "org-users-add", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "x-examples": { - "Example 1": { - "invite_token": "c22c129f-d947-4030-a838-1b498fce21bb", - "email": "w123@nocodb.com" - } - }, - "properties": { - "invite_token": { - "type": "string", - "description": "Invite Token" - }, - "email": { - "type": "string", - "description": "User email", - "example": "user@example.com" - } - } - }, - "examples": { - "Example 1": { - "value": { - "invite_token": "c22c129f-d947-4030-a838-1b498fce21bb", - "email": "user@example.com" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/OrgUserReq" - }, - "examples": { - "Example 1": { - "value": { - "email": "user@example.com", - "roles": "org-level-creator" - } - } - } - } - } - }, - "tags": ["Org Users"], - "description": "Create an organisation user. Exclusive for Super Admin. Access with API Tokens will be blocked.", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/users/{userId}": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "us_b3xo2i44nx5y9l" - }, - "name": "userId", - "in": "path", - "required": true, - "description": "Unique User ID" - } - ], - "patch": { - "summary": "Update Organisation User", - "operationId": "org-users-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "6oa45bkw7j57j" - }, - "example": "The user has been updated successfully" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "The user has been updated successfully" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Org Users"], - "description": "Update an organisation user by User ID. Exclusive for Super Admin. Access with API Tokens will be blocked.", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/OrgUserReq" - }, - "examples": { - "Example 1": { - "value": { - "email": "user@example.com", - "roles": "org-level-creator" - } - } - } - } - }, - "description": "" - } - }, - "delete": { - "summary": "Delete Organisation User", - "operationId": "org-users-delete", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "buvrqjvv255tf" - }, - "example": "The user has been deleted successfully", - "description": "Sucess Message" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "The user has been deleted successfully" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Org Users"], - "description": "Delete an organisation user by User ID. Exclusive for Super Admin. Access with API Tokens will be blocked." - } - }, - "/api/v1/users/{userId}/resend-invite": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "us_b3xo2i44nx5y9l" - }, - "name": "userId", - "in": "path", - "required": true, - "description": "Unique User ID" - } - ], - "post": { - "summary": "Invite Organisation User", - "operationId": "org-users-resend-invite", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "aixfqd9jfh5pq" - }, - "example": "The invitation has been sent to the target user", - "description": "Success Message" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "The invitation has been sent to the target user" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Org Users"], - "description": "Resend Invitation to a specific user. Exclusive for Super Admin. Access with API Tokens will be blocked.", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/users/{userId}/generate-reset-url": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "us_b3xo2i44nx5y9l" - }, - "name": "userId", - "in": "path", - "required": true, - "description": "Unique User ID" - } - ], - "post": { - "summary": "Generate Organisation User Password Reset Token", - "operationId": "org-users-generate-password-reset-token", - "tags": ["Org Users"], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "reset_password_token": { - "type": "string", - "description": "Password Reset Token for the user" - }, - "reset_password_url": { - "type": "string", - "description": "Password Reset URL for the user" - } - } - }, - "examples": { - "Example 1": { - "value": { - "reset_password_token": "string", - "reset_password_url": "string" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Generate Password Reset Token for Organisation User. Exclusive for Super Admin. Access with API Tokens will be blocked.", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/projects/{projectId}/users": { - "get": { - "summary": "List Project Users", - "operationId": "auth-project-user-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "users": { - "type": "object", - "properties": { - "list": { - "type": "array", - "uniqueItems": true, - "minItems": 1, - "items": { - "$ref": "#/components/schemas/User" - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated" - } - }, - "required": ["list", "pageInfo"] - } - } - }, - "examples": { - "Example 1": { - "value": { - "users": { - "list": [ - { - "email": "user@example.com", - "email_verified": true, - "firstname": "Alice", - "id": "us_8kugj628ebjngs", - "lastname": "Smith", - "roles": "org-level-viewer" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "List all users in the given project.", - "tags": ["Auth"], - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - } - ], - "post": { - "summary": "Create Project User", - "operationId": "auth-project-user-add", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "waau9tvy75zsd" - }, - "description": "Success Message for inviting single email", - "example": "The user has been invited successfully" - }, - "invite_token": { - "type": "string", - "x-stoplight": { - "id": "yx0s35u8ds3p7" - }, - "example": "8354ddba-a769-4d64-8397-eccb2e2b3c06" - }, - "error": { - "type": "array", - "x-stoplight": { - "id": "yhfi6wzhr6zr1" - }, - "items": { - "x-stoplight": { - "id": "ce0hlv3d0f96j" - }, - "type": "object", - "properties": { - "email": { - "type": "string", - "x-stoplight": { - "id": "dgnh01j4lxvl1" - }, - "example": "w@nocodb.com" - }, - "error": { - "type": "string", - "x-stoplight": { - "id": "7dgttqiijg8no" - }, - "example": "" - } - } - } - }, - "email": { - "type": "string", - "x-stoplight": { - "id": "08pqst2q30vot" - }, - "example": "w@nocodb.com" - } - } - }, - "examples": { - "Inviting a user without any errors": { - "value": { - "msg": "The user has been invited successfully" - } - }, - "Inviting a user but invitation email failed to send": { - "value": { - "invite_token": "8354ddba-a769-4d64-8397-eccb2e2b3c06", - "email": "w@nocodb.com" - } - }, - "Inviting multiple users": { - "value": { - "invite_token": "8354ddba-a769-4d64-8397-eccb2e2b3c06", - "error": [ - { - "email": "w@nocodb.com", - "error": "" - } - ] - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProjectUserReq" - }, - "examples": { - "Example 1": { - "value": { - "email": "user@example.com", - "roles": "owner" - } - } - } - } - } - }, - "tags": ["Auth"], - "description": "Create a user and add it to the given project", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/projects/{projectId}/info": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - } - ], - "get": { - "summary": "Get Project info", - "operationId": "project-meta-get", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "Node": { - "type": "string", - "description": "Node version", - "example": "v12.16.1" - }, - "Arch": { - "type": "string", - "description": "Architecture type", - "example": "x64" - }, - "Platform": { - "type": "string", - "description": "Platform type", - "example": "linux" - }, - "Docker": { - "type": "boolean", - "description": "Is docker", - "example": false - }, - "Database": { - "type": "string", - "description": "Database type", - "example": "postgres" - }, - "ProjectOnRootDB": { - "type": "boolean", - "description": "Is project on rootdb", - "example": false - }, - "RootDB": { - "type": "string", - "description": "Root database type", - "example": "postgres" - }, - "PackageVersion": { - "type": "string", - "description": "Package version", - "example": "1.0.0" - } - } - }, - "examples": { - "Example 1": { - "value": { - "Node": "v12.16.1", - "Arch": "x64", - "Platform": "linux", - "Docker": false, - "Database": "postgres", - "ProjectOnRootDB": false, - "RootDB": "postgres", - "PackageVersion": "1.0.0" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Project"], - "description": "Get info such as node version, arch, platform, is docker, rootdb and package version of a given project", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/projects/{projectId}/users/{userId}": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - }, - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "us_b3xo2i44nx5y9l" - }, - "name": "userId", - "in": "path", - "required": true, - "description": "Unique User ID" - } - ], - "patch": { - "summary": "Update Project User", - "operationId": "auth-project-user-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "5a2q8as60daly" - }, - "description": "Success Message", - "example": "The user has been updated successfully" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "The user has been updated successfully" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProjectUserReq" - }, - "examples": { - "Example 1": { - "value": { - "email": "user@example.com", - "roles": "owner" - } - } - } - } - } - }, - "tags": ["Auth"], - "description": "Update a given user in a given project. Exclusive for Super Admin. Access with API Tokens will be blocked.", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "delete": { - "summary": "Delete Project User", - "operationId": "auth-project-user-remove", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "5h7c9lqh5ynve" - }, - "example": "The user has been updated successfully", - "description": "Success Message" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "The user has been updated successfully" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Auth"], - "description": "Delete a given user in a given project. Exclusive for Super Admin. Access with API Tokens will be blocked.", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/projects/{projectId}/visibility-rules": { - "get": { - "summary": "Get UI ACL", - "operationId": "project-model-visibility-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": {} - }, - "examples": { - "Example 1": { - "value": [ - { - "ptn": "nc_09gt___Sheet-1", - "_ptn": "Sheet-1", - "ptype": "table", - "tn": "Sheet-1", - "_tn": "Sheet-1", - "table_meta": null, - "id": "vw_75neroyqdye94k", - "base_id": "ds_eol59jg2l4zwev", - "project_id": "p_63b4q0qengen1x", - "fk_model_id": "md_5mipbdg6ketmv8", - "title": "Sheet-1", - "type": 3, - "is_default": true, - "show_system_fields": null, - "lock_type": "collaborative", - "uuid": "24a6d0bb-e45d-4b1a-bfef-f492d870de9f", - "password": null, - "show": true, - "order": 1, - "created_at": "2023-03-08T10:44:55.253Z", - "updated_at": "2023-03-10T07:18:44.908Z", - "meta": { - "allowCSVDownload": true - }, - "view": { - "fk_view_id": "vw_75neroyqdye94k", - "base_id": "ds_eol59jg2l4zwev", - "project_id": "p_63b4q0qengen1x", - "uuid": null, - "created_at": "2023-03-08T10:44:55.288Z", - "updated_at": "2023-03-08T10:44:55.288Z", - "meta": null, - "row_height": null - }, - "disabled": { - "owner": false, - "creator": false, - "viewer": false, - "editor": false, - "commenter": false, - "guest": false - } - } - ] - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Hide / show views based on user role", - "tags": ["Project"], - "parameters": [ - { - "schema": { - "type": "boolean" - }, - "in": "query", - "name": "includeM2M" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - } - ], - "post": { - "summary": "Create UI ACL", - "operationId": "project-model-visibility-set", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "2txh071wsodys" - }, - "example": "UI ACL has been created successfully" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "UI ACL has been created successfully" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VisibilityRuleReq" - } - } - } - }, - "tags": ["Project"], - "description": "Hide / show views based on user role", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/projects/": { - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "get": { - "summary": "List Projects", - "operationId": "project-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProjectList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "bases": [ - { - "alias": "string", - "config": null, - "created_at": "2023-03-01 14:27:36", - "enabled": true, - "id": "string", - "inflection_column": "camelize", - "inflection_table": "camelize", - "is_meta": true, - "order": 1, - "project_id": "string", - "type": "mysql2", - "updated_at": "2023-03-01 14:27:36" - } - ], - "color": "#24716E", - "created_at": "2023-03-01 14:27:36", - "deleted": true, - "description": "This is my project description", - "id": "p_124hhlkbeasewh", - "is_meta": true, - "meta": {}, - "order": 0, - "prefix": "nc_vm5q__", - "status": "string", - "title": "my-project", - "updated_at": "2023-03-01 14:27:36" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "List all project meta data", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["Project"] - }, - "post": { - "summary": "Create Project", - "operationId": "project-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProjectReq" - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/Project" - }, - { - "type": "object", - "properties": { - "external": { - "type": "boolean", - "default": false, - "description": "If true, the project will us an external database else it will use the root database" - } - } - } - ] - }, - "examples": { - "Example 1": { - "value": { - "bases": [ - { - "alias": "string", - "config": null, - "enabled": true, - "id": "string", - "inflection_column": "camelize", - "inflection_table": "camelize", - "is_meta": true, - "order": 1, - "project_id": "string", - "type": "mysql2", - "updated_at": "2023-03-01 14:27:36" - } - ], - "color": "#24716E", - "created_at": "2023-03-01 14:27:36", - "deleted": true, - "description": "This is my project description", - "id": "p_124hhlkbeasewh", - "is_meta": true, - "meta": {}, - "order": 0, - "prefix": "nc_vm5q__", - "status": "string", - "title": "my-project", - "external": false - } - } - } - } - } - }, - "tags": ["Project"], - "description": "Create a new project", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/projects/{projectId}": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - } - ], - "get": { - "summary": "Get Project", - "operationId": "project-read", - "description": "Get the info of a given project", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["Project"], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Project" - }, - "examples": { - "Example 1": { - "value": { - "bases": [ - { - "alias": "string", - "config": null, - "enabled": true, - "id": "string", - "inflection_column": "camelize", - "inflection_table": "camelize", - "is_meta": true, - "order": 1, - "project_id": "string", - "type": "mysql2", - "updated_at": "2023-03-01 14:27:36" - } - ], - "color": "#24716E", - "created_at": "2023-03-01 14:27:36", - "deleted": true, - "description": "This is my project description", - "id": "p_124hhlkbeasewh", - "is_meta": true, - "meta": {}, - "order": 0, - "prefix": "nc_vm5q__", - "status": "string", - "title": "my-project" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - } - }, - "delete": { - "summary": "Delete Project", - "operationId": "project-delete", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "boolean" - }, - "examples": { - "Example 1": { - "value": true - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Project"], - "description": "Delete the given project", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "patch": { - "summary": "Update Project", - "operationId": "project-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number", - "example": 1 - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Project"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProjectUpdateReq" - }, - "examples": { - "Example 1": { - "value": { - "color": "#24716E", - "meta": null, - "title": "My Project" - } - } - } - } - } - }, - "description": "Update the given project", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/projects/{projectId}/bases/{baseId}": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - }, - { - "schema": { - "type": "string", - "pattern": "ds_j04jmxh5xg10lu" - }, - "name": "baseId", - "in": "path", - "required": true, - "description": "Unique Base ID" - } - ], - "get": { - "summary": "Get Base", - "operationId": "base-read", - "description": "Get the base details of a given project", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["Base"], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Base" - }, - "examples": { - "Example 1": { - "value": { - "alias": null, - "config": "", - "enabled": 1, - "id": "ds_krsappzu9f8vmo", - "inflection_column": "camelize", - "inflection_table": "camelize", - "is_meta": 1, - "meta": null, - "order": 1, - "project_id": "p_01clqvzik3izk6", - "type": "mysql2" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - } - }, - "delete": { - "summary": "Delete Base", - "operationId": "base-delete", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "boolean" - }, - "examples": { - "Example 1": { - "value": true - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Base"], - "description": "Delete the base details of a given project", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "patch": { - "summary": "Update Base", - "operationId": "base-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {} - }, - "examples": { - "Example 1": { - "value": { - "id": "ds_rrplkgy0pq1f3c", - "project_id": "p_63b4q0qengen1x", - "alias": "sakila", - "meta": null, - "is_meta": null, - "type": "mysql2", - "inflection_column": "camelize", - "inflection_table": "camelize", - "created_at": "2023-03-11T10:31:15.341Z", - "updated_at": "2023-03-11T10:32:25.763Z", - "enabled": true, - "order": 2 - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Base"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "examples": { - "Example 1": { - "value": { - "alias": "sakila", - "type": "mysql2", - "config": { - "client": "mysql2", - "connection": { - "host": "localhost", - "port": "3306", - "user": "root", - "password": "password", - "database": "sakila" - } - }, - "inflection_column": "camelize", - "inflection_table": "camelize" - } - } - } - } - } - }, - "description": "Update the base details of a given project", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/projects/{projectId}/bases/": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - } - ], - "get": { - "summary": "List Bases", - "operationId": "base-list", - "description": "Get project base list", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["Base"], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BaseList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "alias": null, - "config": "", - "enabled": 1, - "id": "ds_krsappzu9f8vmo", - "inflection_column": "camelize", - "inflection_table": "camelize", - "is_meta": 1, - "meta": null, - "order": 1, - "project_id": "p_01clqvzik3izk6", - "type": "mysql2" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - } - }, - "post": { - "summary": "Create Base", - "operationId": "base-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Base" - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/Base" - }, - { - "type": "object", - "properties": { - "external": { - "type": "boolean", - "default": false - } - } - } - ] - }, - "examples": { - "Example 1": { - "value": { - "alias": null, - "config": "", - "enabled": 1, - "id": "ds_krsappzu9f8vmo", - "inflection_column": "camelize", - "inflection_table": "camelize", - "is_meta": 1, - "meta": null, - "order": 1, - "project_id": "p_01clqvzik3izk6", - "type": "mysql2", - "external": false - } - } - } - } - } - }, - "tags": ["Base"], - "description": "Create a new base on a given project", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/projects/{projectId}/shared": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - } - ], - "get": { - "summary": "Get Project Shared Base", - "operationId": "project-shared-base-get", - "description": "Get Project Shared Base", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["Project"], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "uuid": { - "type": "string", - "format": "uuid", - "example": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11" - }, - "url": { - "type": "string", - "format": "uri" - }, - "roles": { - "type": "string", - "example": "viewer" - } - } - }, - "examples": { - "Example 1": { - "value": { - "uuid": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11", - "url": "http://example.com", - "roles": "viewer" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - } - }, - "delete": { - "summary": "Delete Project Shared Base", - "operationId": "project-shared-base-disable", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "boolean" - }, - "examples": { - "Example 1": { - "value": true - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Project"], - "description": "Delete Project Shared Base", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "post": { - "summary": "Create Project Shared Base", - "operationId": "project-shared-base-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "uuid": { - "$ref": "#/components/schemas/StringOrNull" - }, - "roles": { - "$ref": "#/components/schemas/StringOrNull" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Project"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SharedBaseReq" - }, - "examples": { - "Example 1": { - "value": { - "roles": "editor", - "password": "password123" - } - } - } - } - } - }, - "description": "Create Project Shared Base", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "patch": { - "summary": "Update Project Shared Base", - "operationId": "project-shared-base-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "uuid": { - "type": "string", - "format": "uuid", - "example": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11" - }, - "url": { - "type": "string", - "format": "uri" - }, - "roles": { - "type": "string", - "example": "viewer" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SharedBaseReq" - }, - "examples": { - "Example 1": { - "value": { - "password": "password123", - "roles": "editor" - } - } - } - } - } - }, - "tags": ["Project"], - "description": "Update Project Shared Base", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/projects/{projectId}/cost": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - } - ], - "get": { - "summary": "Project Cost", - "operationId": "project-cost", - "description": "Calculate the Project Cost", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["Project"], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {} - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "x-internal": true - } - }, - "/api/v1/db/meta/projects/{projectId}/tables": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - } - ], - "post": { - "summary": "Create Table", - "operationId": "db-table-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Table" - }, - "examples": { - "Example 1": { - "value": { - "base_id": "ds_g4ccx6e77h1dmi", - "columns": [ - { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": "CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP", - "clen": null, - "column_name": "updated_at", - "cop": "4", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "timestamp", - "deleted": null, - "dt": "timestamp", - "dtx": "specificType", - "dtxp": "0", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_m4wkaqgqqjzoeh", - "meta": null, - "np": null, - "ns": null, - "order": 4, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 0, - "system": 0, - "title": "UpdatedAt", - "uidt": "DateTime", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": "CURRENT_TIMESTAMP", - "clen": null, - "column_name": "created_at", - "cop": "3", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "timestamp", - "deleted": null, - "dt": "timestamp", - "dtx": "specificType", - "dtxp": "0", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_jpl0qu4gj4rexq", - "meta": null, - "np": null, - "ns": null, - "order": 3, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 0, - "system": 0, - "title": "CreatedAt", - "uidt": "DateTime", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": null, - "clen": "45", - "column_name": "title", - "cop": "2", - "created_at": "2023-03-02 17:04:06", - "csn": "utf8mb4", - "ct": "varchar(45)", - "deleted": null, - "dt": "varchar", - "dtx": "specificType", - "dtxp": "45", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_c5knoi4xs4sfpt", - "meta": null, - "np": null, - "ns": null, - "order": 2, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": 1, - "rqd": 0, - "system": 0, - "title": "Title", - "uidt": "SingleLineText", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - { - "ai": 1, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": null, - "clen": null, - "column_name": "id", - "cop": "1", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "int unsigned", - "deleted": null, - "dt": "int", - "dtx": "specificType", - "dtxp": "", - "dtxs": "0", - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_phvuuwjrzcdo0g", - "meta": null, - "np": "10", - "ns": "0", - "order": 1, - "pk": 1, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 1, - "system": 0, - "title": "Id", - "uidt": "ID", - "un": 1, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - } - ], - "columnsById": { - "cl_c5knoi4xs4sfpt": { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": null, - "clen": "45", - "column_name": "title", - "cop": "2", - "created_at": "2023-03-02 17:04:06", - "csn": "utf8mb4", - "ct": "varchar(45)", - "deleted": null, - "dt": "varchar", - "dtx": "specificType", - "dtxp": "45", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_c5knoi4xs4sfpt", - "meta": null, - "np": null, - "ns": null, - "order": 2, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": 1, - "rqd": 0, - "system": 0, - "title": "Title", - "uidt": "SingleLineText", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - "cl_jpl0qu4gj4rexq": { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": "CURRENT_TIMESTAMP", - "clen": null, - "column_name": "created_at", - "cop": "3", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "timestamp", - "deleted": null, - "dt": "timestamp", - "dtx": "specificType", - "dtxp": "0", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_jpl0qu4gj4rexq", - "meta": null, - "np": null, - "ns": null, - "order": 3, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 0, - "system": 0, - "title": "CreatedAt", - "uidt": "DateTime", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - "cl_m4wkaqgqqjzoeh": { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": "CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP", - "clen": null, - "column_name": "updated_at", - "cop": "4", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "timestamp", - "deleted": null, - "dt": "timestamp", - "dtx": "specificType", - "dtxp": "0", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_m4wkaqgqqjzoeh", - "meta": null, - "np": null, - "ns": null, - "order": 4, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 0, - "system": 0, - "title": "UpdatedAt", - "uidt": "DateTime", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - "cl_phvuuwjrzcdo0g": { - "ai": 1, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": null, - "clen": null, - "column_name": "id", - "cop": "1", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "int unsigned", - "deleted": null, - "dt": "int", - "dtx": "specificType", - "dtxp": "", - "dtxs": "0", - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_phvuuwjrzcdo0g", - "meta": null, - "np": "10", - "ns": "0", - "order": 1, - "pk": 1, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 1, - "system": 0, - "title": "Id", - "uidt": "ID", - "un": 1, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - } - }, - "created_at": "2023-03-02 17:04:06", - "deleted": null, - "enabled": 1, - "id": "md_rsu68aqjsbyqtl", - "meta": null, - "mm": 0, - "order": 1, - "pinned": null, - "project_id": "p_xm3thidrblw4n7", - "schema": null, - "table_name": "nc_vm5q___Table1", - "tags": null, - "title": "Table1", - "type": "table", - "updated_at": "2023-03-02 17:04:08", - "views": [ - { - "_ptn": "Table1", - "_tn": "Table1", - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:04:06", - "disabled": { - "commenter": false, - "creator": false, - "editor": false, - "guest": false, - "owner": false, - "viewer": false - }, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "vw_p2jcatxz4mvcfw", - "is_default": 1, - "lock_type": "collaborative", - "meta": {}, - "order": 1, - "password": null, - "project_id": "p_xm3thidrblw4n7", - "ptn": "nc_vm5q___Table1", - "ptype": "table", - "show": 1, - "show_system_fields": null, - "table_meta": null, - "title": "Table1", - "tn": "Table1", - "type": 3, - "updated_at": "2023-03-02 17:04:06", - "uuid": null, - "view": { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:04:06", - "fk_view_id": "vw_p2jcatxz4mvcfw", - "meta": null, - "project_id": "p_xm3thidrblw4n7", - "row_height": null, - "updated_at": "2023-03-02 17:04:06", - "uuid": null - } - } - ] - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TableReq" - } - } - } - }, - "tags": ["DB Table"], - "description": "Create a new table in a given project", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "get": { - "summary": "List Tables", - "operationId": "db-table-list", - "responses": { - "200": { - "$ref": "#/components/responses/TableList" - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - }, - { - "schema": { - "type": "number" - }, - "in": "query", - "name": "page" - }, - { - "schema": { - "type": "number" - }, - "in": "query", - "name": "pageSize" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "sort" - }, - { - "schema": { - "type": "boolean" - }, - "in": "query", - "name": "includeM2M" - } - ], - "tags": ["DB Table"], - "description": "List all tables in a given project" - } - }, - "/api/v1/db/meta/tables/{tableId}": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "md_w9gpnaousnfss1", - "type": "string" - }, - "name": "tableId", - "in": "path", - "required": true, - "description": "Unique Table ID" - } - ], - "get": { - "summary": "Read Table", - "operationId": "db-table-read", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Table" - }, - "examples": { - "Example 1": { - "value": { - "id": "md_rsu68aqjsbyqtl", - "base_id": "ds_g4ccx6e77h1dmi", - "project_id": "p_xm3thidrblw4n7", - "table_name": "nc_vm5q___Table1", - "title": "Table1", - "type": "table", - "meta": null, - "schema": null, - "enabled": 1, - "mm": 0, - "tags": null, - "pinned": null, - "deleted": null, - "order": 1, - "created_at": "2023-03-02 17:04:06", - "updated_at": "2023-03-02 17:04:08", - "columns": [ - { - "id": "cl_phvuuwjrzcdo0g", - "base_id": "ds_g4ccx6e77h1dmi", - "project_id": "p_xm3thidrblw4n7", - "fk_model_id": "md_rsu68aqjsbyqtl", - "title": "Id", - "column_name": "id", - "uidt": "ID", - "dt": "int", - "np": "10", - "ns": "0", - "clen": null, - "cop": "1", - "pk": 1, - "pv": null, - "rqd": 1, - "un": 1, - "ct": "int unsigned", - "ai": 1, - "unique": 0, - "cdf": null, - "cc": "", - "csn": null, - "dtx": "specificType", - "dtxp": "", - "dtxs": "0", - "au": 0, - "validate": null, - "virtual": null, - "deleted": null, - "system": 0, - "order": 1, - "created_at": "2023-03-02 17:04:06", - "updated_at": "2023-03-02 17:04:06", - "meta": null - }, - { - "id": "cl_c5knoi4xs4sfpt", - "base_id": "ds_g4ccx6e77h1dmi", - "project_id": "p_xm3thidrblw4n7", - "fk_model_id": "md_rsu68aqjsbyqtl", - "title": "Title", - "column_name": "title", - "uidt": "SingleLineText", - "dt": "varchar", - "np": null, - "ns": null, - "clen": "45", - "cop": "2", - "pk": 0, - "pv": 1, - "rqd": 0, - "un": 0, - "ct": "varchar(45)", - "ai": 0, - "unique": 0, - "cdf": null, - "cc": "", - "csn": "utf8mb4", - "dtx": "specificType", - "dtxp": "45", - "dtxs": null, - "au": 0, - "validate": null, - "virtual": null, - "deleted": null, - "system": 0, - "order": 2, - "created_at": "2023-03-02 17:04:06", - "updated_at": "2023-03-02 17:04:06", - "meta": null - }, - { - "id": "cl_jpl0qu4gj4rexq", - "base_id": "ds_g4ccx6e77h1dmi", - "project_id": "p_xm3thidrblw4n7", - "fk_model_id": "md_rsu68aqjsbyqtl", - "title": "CreatedAt", - "column_name": "created_at", - "uidt": "DateTime", - "dt": "timestamp", - "np": null, - "ns": null, - "clen": null, - "cop": "3", - "pk": 0, - "pv": null, - "rqd": 0, - "un": 0, - "ct": "timestamp", - "ai": 0, - "unique": 0, - "cdf": "CURRENT_TIMESTAMP", - "cc": "", - "csn": null, - "dtx": "specificType", - "dtxp": "0", - "dtxs": null, - "au": 0, - "validate": null, - "virtual": null, - "deleted": null, - "system": 0, - "order": 3, - "created_at": "2023-03-02 17:04:06", - "updated_at": "2023-03-02 17:04:06", - "meta": null - }, - { - "id": "cl_m4wkaqgqqjzoeh", - "base_id": "ds_g4ccx6e77h1dmi", - "project_id": "p_xm3thidrblw4n7", - "fk_model_id": "md_rsu68aqjsbyqtl", - "title": "UpdatedAt", - "column_name": "updated_at", - "uidt": "DateTime", - "dt": "timestamp", - "np": null, - "ns": null, - "clen": null, - "cop": "4", - "pk": 0, - "pv": null, - "rqd": 0, - "un": 0, - "ct": "timestamp", - "ai": 0, - "unique": 0, - "cdf": "CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP", - "cc": "", - "csn": null, - "dtx": "specificType", - "dtxp": "0", - "dtxs": null, - "au": 0, - "validate": null, - "virtual": null, - "deleted": null, - "system": 0, - "order": 4, - "created_at": "2023-03-02 17:04:06", - "updated_at": "2023-03-02 17:04:06", - "meta": null - } - ], - "views": [ - { - "ptn": "nc_vm5q___Table1", - "_ptn": "Table1", - "ptype": "table", - "tn": "Table1", - "_tn": "Table1", - "table_meta": null, - "id": "vw_p2jcatxz4mvcfw", - "base_id": "ds_g4ccx6e77h1dmi", - "project_id": "p_xm3thidrblw4n7", - "fk_model_id": "md_rsu68aqjsbyqtl", - "title": "Table1", - "type": 3, - "is_default": 1, - "show_system_fields": null, - "lock_type": "collaborative", - "uuid": null, - "password": null, - "show": 1, - "order": 1, - "created_at": "2023-03-02 17:04:06", - "updated_at": "2023-03-02 17:04:06", - "meta": {}, - "view": { - "fk_view_id": "vw_p2jcatxz4mvcfw", - "base_id": "ds_g4ccx6e77h1dmi", - "project_id": "p_xm3thidrblw4n7", - "uuid": null, - "created_at": "2023-03-02 17:04:06", - "updated_at": "2023-03-02 17:04:06", - "meta": null, - "row_height": null - }, - "disabled": { - "owner": false, - "creator": false, - "viewer": false, - "editor": false, - "commenter": false, - "guest": false - } - } - ], - "columnsById": { - "cl_phvuuwjrzcdo0g": { - "id": "cl_phvuuwjrzcdo0g", - "base_id": "ds_g4ccx6e77h1dmi", - "project_id": "p_xm3thidrblw4n7", - "fk_model_id": "md_rsu68aqjsbyqtl", - "title": "Id", - "column_name": "id", - "uidt": "ID", - "dt": "int", - "np": "10", - "ns": "0", - "clen": null, - "cop": "1", - "pk": 1, - "pv": null, - "rqd": 1, - "un": 1, - "ct": "int unsigned", - "ai": 1, - "unique": 0, - "cdf": null, - "cc": "", - "csn": null, - "dtx": "specificType", - "dtxp": "", - "dtxs": "0", - "au": 0, - "validate": null, - "virtual": null, - "deleted": null, - "system": 0, - "order": 1, - "created_at": "2023-03-02 17:04:06", - "updated_at": "2023-03-02 17:04:06", - "meta": null - }, - "cl_c5knoi4xs4sfpt": { - "id": "cl_c5knoi4xs4sfpt", - "base_id": "ds_g4ccx6e77h1dmi", - "project_id": "p_xm3thidrblw4n7", - "fk_model_id": "md_rsu68aqjsbyqtl", - "title": "Title", - "column_name": "title", - "uidt": "SingleLineText", - "dt": "varchar", - "np": null, - "ns": null, - "clen": "45", - "cop": "2", - "pk": 0, - "pv": 1, - "rqd": 0, - "un": 0, - "ct": "varchar(45)", - "ai": 0, - "unique": 0, - "cdf": null, - "cc": "", - "csn": "utf8mb4", - "dtx": "specificType", - "dtxp": "45", - "dtxs": null, - "au": 0, - "validate": null, - "virtual": null, - "deleted": null, - "system": 0, - "order": 2, - "created_at": "2023-03-02 17:04:06", - "updated_at": "2023-03-02 17:04:06", - "meta": null - }, - "cl_jpl0qu4gj4rexq": { - "id": "cl_jpl0qu4gj4rexq", - "base_id": "ds_g4ccx6e77h1dmi", - "project_id": "p_xm3thidrblw4n7", - "fk_model_id": "md_rsu68aqjsbyqtl", - "title": "CreatedAt", - "column_name": "created_at", - "uidt": "DateTime", - "dt": "timestamp", - "np": null, - "ns": null, - "clen": null, - "cop": "3", - "pk": 0, - "pv": null, - "rqd": 0, - "un": 0, - "ct": "timestamp", - "ai": 0, - "unique": 0, - "cdf": "CURRENT_TIMESTAMP", - "cc": "", - "csn": null, - "dtx": "specificType", - "dtxp": "0", - "dtxs": null, - "au": 0, - "validate": null, - "virtual": null, - "deleted": null, - "system": 0, - "order": 3, - "created_at": "2023-03-02 17:04:06", - "updated_at": "2023-03-02 17:04:06", - "meta": null - }, - "cl_m4wkaqgqqjzoeh": { - "id": "cl_m4wkaqgqqjzoeh", - "base_id": "ds_g4ccx6e77h1dmi", - "project_id": "p_xm3thidrblw4n7", - "fk_model_id": "md_rsu68aqjsbyqtl", - "title": "UpdatedAt", - "column_name": "updated_at", - "uidt": "DateTime", - "dt": "timestamp", - "np": null, - "ns": null, - "clen": null, - "cop": "4", - "pk": 0, - "pv": null, - "rqd": 0, - "un": 0, - "ct": "timestamp", - "ai": 0, - "unique": 0, - "cdf": "CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP", - "cc": "", - "csn": null, - "dtx": "specificType", - "dtxp": "0", - "dtxs": null, - "au": 0, - "validate": null, - "virtual": null, - "deleted": null, - "system": 0, - "order": 4, - "created_at": "2023-03-02 17:04:06", - "updated_at": "2023-03-02 17:04:06", - "meta": null - } - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table"], - "description": "Read the table meta data by the given table ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "patch": { - "summary": "Update Table", - "operationId": "db-table-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "5a0g9yvs4e678" - }, - "example": "The table has been updated successfully" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "The table has been updated successfully" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "table_name": { - "type": "string", - "description": "Table name", - "example": "users" - }, - "title": { - "type": "string", - "description": "Table title", - "example": "Users" - }, - "project_id": { - "type": "string", - "description": "Project ID", - "example": "p_124hhlkbeasewh" - }, - "meta": { - "$ref": "#/components/schemas/Meta" - } - } - }, - "examples": { - "Example 1": { - "value": { - "table_name": "users", - "title": "Users", - "project_id": "p_124hhlkbeasewh", - "meta": null - } - } - } - } - } - }, - "description": "Update the table meta data by the given table ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "delete": { - "summary": "Delete Table", - "operationId": "db-table-delete", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "boolean" - }, - "examples": { - "Example 1": { - "value": true - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table"], - "description": "Delete the table meta data by the given table ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/projects/{projectId}/{baseId}/tables": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - }, - { - "schema": { - "type": "string", - "pattern": "ds_j04jmxh5xg10lu" - }, - "name": "baseId", - "in": "path", - "required": true, - "description": "Unique Base ID" - } - ], - "get": { - "summary": "List Tables", - "operationId": "table-list", - "responses": { - "200": { - "$ref": "#/components/responses/TableList" - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - }, - { - "schema": { - "type": "number" - }, - "in": "query", - "name": "page" - }, - { - "schema": { - "type": "number" - }, - "in": "query", - "name": "pageSize" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "sort" - }, - { - "schema": { - "type": "boolean" - }, - "in": "query", - "name": "includeM2M" - } - ], - "tags": ["Base"], - "description": "List all tables in a given Project and Base" - }, - "post": { - "summary": "Create Table", - "operationId": "table-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Table" - }, - "examples": { - "Example 1": { - "value": { - "base_id": "ds_g4ccx6e77h1dmi", - "columns": [ - { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": "CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP", - "clen": null, - "column_name": "updated_at", - "cop": "4", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "timestamp", - "deleted": null, - "dt": "timestamp", - "dtx": "specificType", - "dtxp": "0", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_m4wkaqgqqjzoeh", - "meta": null, - "np": null, - "ns": null, - "order": 4, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 0, - "system": 0, - "title": "UpdatedAt", - "uidt": "DateTime", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": "CURRENT_TIMESTAMP", - "clen": null, - "column_name": "created_at", - "cop": "3", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "timestamp", - "deleted": null, - "dt": "timestamp", - "dtx": "specificType", - "dtxp": "0", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_jpl0qu4gj4rexq", - "meta": null, - "np": null, - "ns": null, - "order": 3, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 0, - "system": 0, - "title": "CreatedAt", - "uidt": "DateTime", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": null, - "clen": "45", - "column_name": "title", - "cop": "2", - "created_at": "2023-03-02 17:04:06", - "csn": "utf8mb4", - "ct": "varchar(45)", - "deleted": null, - "dt": "varchar", - "dtx": "specificType", - "dtxp": "45", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_c5knoi4xs4sfpt", - "meta": null, - "np": null, - "ns": null, - "order": 2, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": 1, - "rqd": 0, - "system": 0, - "title": "Title", - "uidt": "SingleLineText", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - { - "ai": 1, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": null, - "clen": null, - "column_name": "id", - "cop": "1", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "int unsigned", - "deleted": null, - "dt": "int", - "dtx": "specificType", - "dtxp": "", - "dtxs": "0", - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_phvuuwjrzcdo0g", - "meta": null, - "np": "10", - "ns": "0", - "order": 1, - "pk": 1, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 1, - "system": 0, - "title": "Id", - "uidt": "ID", - "un": 1, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - } - ], - "columnsById": { - "cl_c5knoi4xs4sfpt": { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": null, - "clen": "45", - "column_name": "title", - "cop": "2", - "created_at": "2023-03-02 17:04:06", - "csn": "utf8mb4", - "ct": "varchar(45)", - "deleted": null, - "dt": "varchar", - "dtx": "specificType", - "dtxp": "45", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_c5knoi4xs4sfpt", - "meta": null, - "np": null, - "ns": null, - "order": 2, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": 1, - "rqd": 0, - "system": 0, - "title": "Title", - "uidt": "SingleLineText", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - "cl_jpl0qu4gj4rexq": { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": "CURRENT_TIMESTAMP", - "clen": null, - "column_name": "created_at", - "cop": "3", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "timestamp", - "deleted": null, - "dt": "timestamp", - "dtx": "specificType", - "dtxp": "0", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_jpl0qu4gj4rexq", - "meta": null, - "np": null, - "ns": null, - "order": 3, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 0, - "system": 0, - "title": "CreatedAt", - "uidt": "DateTime", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - "cl_m4wkaqgqqjzoeh": { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": "CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP", - "clen": null, - "column_name": "updated_at", - "cop": "4", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "timestamp", - "deleted": null, - "dt": "timestamp", - "dtx": "specificType", - "dtxp": "0", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_m4wkaqgqqjzoeh", - "meta": null, - "np": null, - "ns": null, - "order": 4, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 0, - "system": 0, - "title": "UpdatedAt", - "uidt": "DateTime", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - "cl_phvuuwjrzcdo0g": { - "ai": 1, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": null, - "clen": null, - "column_name": "id", - "cop": "1", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "int unsigned", - "deleted": null, - "dt": "int", - "dtx": "specificType", - "dtxp": "", - "dtxs": "0", - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_phvuuwjrzcdo0g", - "meta": null, - "np": "10", - "ns": "0", - "order": 1, - "pk": 1, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 1, - "system": 0, - "title": "Id", - "uidt": "ID", - "un": 1, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - } - }, - "created_at": "2023-03-02 17:04:06", - "deleted": null, - "enabled": 1, - "id": "md_rsu68aqjsbyqtl", - "meta": null, - "mm": 0, - "order": 1, - "pinned": null, - "project_id": "p_xm3thidrblw4n7", - "schema": null, - "table_name": "nc_vm5q___Table1", - "tags": null, - "title": "Table1", - "type": "table", - "updated_at": "2023-03-02 17:04:08", - "views": [ - { - "_ptn": "Table1", - "_tn": "Table1", - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:04:06", - "disabled": { - "commenter": false, - "creator": false, - "editor": false, - "guest": false, - "owner": false, - "viewer": false - }, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "vw_p2jcatxz4mvcfw", - "is_default": 1, - "lock_type": "collaborative", - "meta": {}, - "order": 1, - "password": null, - "project_id": "p_xm3thidrblw4n7", - "ptn": "nc_vm5q___Table1", - "ptype": "table", - "show": 1, - "show_system_fields": null, - "table_meta": null, - "title": "Table1", - "tn": "Table1", - "type": 3, - "updated_at": "2023-03-02 17:04:06", - "uuid": null, - "view": { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:04:06", - "fk_view_id": "vw_p2jcatxz4mvcfw", - "meta": null, - "project_id": "p_xm3thidrblw4n7", - "row_height": null, - "updated_at": "2023-03-02 17:04:06", - "uuid": null - } - } - ] - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TableReq" - }, - "examples": { - "Example 1": { - "value": { - "columns": [ - { - "ai": false, - "altered": 1, - "cdf": "CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP", - "ck": false, - "clen": 45, - "column_name": "updated_at", - "ct": "varchar(45)", - "dt": "timestamp", - "dtx": "specificType", - "dtxp": "", - "dtxs": "", - "np": null, - "nrqd": true, - "ns": null, - "pk": false, - "rqd": false, - "title": "UpdatedAt", - "uicn": "", - "uidt": "DateTime", - "uip": "", - "un": false - }, - { - "ai": false, - "altered": 1, - "cdf": "CURRENT_TIMESTAMP", - "ck": false, - "clen": 45, - "column_name": "created_at", - "ct": "varchar(45)", - "dt": "timestamp", - "dtx": "specificType", - "dtxp": "", - "dtxs": "", - "np": null, - "nrqd": true, - "ns": null, - "pk": false, - "rqd": false, - "title": "CreatedAt", - "uicn": "", - "uidt": "DateTime", - "uip": "", - "un": false - }, - { - "ai": false, - "altered": 1, - "cdf": null, - "ck": false, - "clen": 45, - "column_name": "title", - "ct": "varchar(45)", - "dt": "varchar", - "dtx": "specificType", - "dtxp": "45", - "dtxs": "", - "np": null, - "nrqd": true, - "ns": null, - "pk": false, - "rqd": false, - "title": "Title", - "uicn": "", - "uidt": "SingleLineText", - "uip": "", - "un": false - }, - { - "ai": true, - "altered": 1, - "cdf": null, - "ck": false, - "clen": null, - "column_name": "id", - "ct": "int(11)", - "dt": "int", - "dtx": "integer", - "dtxp": "11", - "dtxs": "", - "np": 11, - "nrqd": false, - "ns": 0, - "pk": true, - "rqd": true, - "title": "Id", - "uicn": "", - "uidt": "ID", - "uip": "", - "un": true - } - ], - "table_name": "Sheet-1", - "title": "Sheet-1" - } - } - } - } - } - }, - "tags": ["Base"], - "description": "Create a new table in a given Project and Base", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/tables/{tableId}/reorder": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "md_w9gpnaousnfss1", - "type": "string" - }, - "name": "tableId", - "in": "path", - "required": true, - "description": "Unique Table ID" - } - ], - "post": { - "summary": "Reorder Table", - "operationId": "db-table-reorder", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "boolean" - }, - "examples": { - "Example 1": { - "value": true - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "order": { - "type": "number" - } - } - }, - "examples": { - "Example 1": { - "value": { - "order": 0 - } - } - } - } - } - }, - "tags": ["DB Table"], - "description": "Update the order of the given Table", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/tables/{tableId}/columns": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "md_w9gpnaousnfss1", - "type": "string" - }, - "name": "tableId", - "in": "path", - "required": true, - "description": "Unique Table ID" - } - ], - "post": { - "summary": "Create Column", - "operationId": "db-table-column-create", - "responses": { - "200": { - "description": "OK" - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ColumnReq" - }, - "examples": { - "Example 1": { - "value": { - "ai": 0, - "au": 0, - "base_id": "ds_krsappzu9f8vmo", - "cc": "", - "cdf": null, - "clen": "45", - "column_name": "title", - "cop": "2", - "csn": "utf8mb4", - "ct": "varchar(45)", - "deleted": null, - "dt": "varchar", - "dtx": "specificType", - "dtxp": "45", - "dtxs": null, - "fk_model_id": "md_yvwvbt2i78rgcm", - "id": "cl_0j9gv0oi8vjy46", - "meta": null, - "np": null, - "ns": null, - "order": 2, - "pk": 0, - "project_id": "p_01clqvzik3izk6", - "pv": 1, - "rqd": 0, - "system": 0, - "title": "Title", - "uidt": "SingleLineText", - "un": 0, - "unique": 0, - "validate": null, - "virtual": null - } - } - } - } - } - }, - "tags": ["DB Table Column"], - "description": "Create a new column in a given Table", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/columns/{columnId}": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "columnId", - "in": "path", - "required": true - } - ], - "patch": { - "summary": "Update Column", - "operationId": "db-table-column-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Column" - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ColumnReq" - } - } - } - }, - "tags": ["DB Table Column"], - "description": "Update the existing column by the given column ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "delete": { - "summary": "Delete Column", - "operationId": "db-table-column-delete", - "responses": { - "200": { - "description": "OK" - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Column"], - "description": "Delete the existing column by the given column ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "get": { - "summary": "Get Column", - "operationId": "db-table-column-get", - "responses": { - "200": { - "description": "OK" - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Column"], - "description": "Get the existing column by the given column ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/columns/{columnId}/primary": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "columnId", - "in": "path", - "required": true - } - ], - "post": { - "summary": "Create Primary Value", - "operationId": "db-table-column-primary-column-set", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "boolean" - }, - "examples": { - "Example 1": { - "value": true - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Column"], - "description": "Set a primary value on a given column", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/tables/{tableId}/views": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "md_w9gpnaousnfss1", - "type": "string" - }, - "name": "tableId", - "in": "path", - "required": true, - "description": "Unique Table ID" - } - ], - "get": { - "summary": "List Views", - "operationId": "db-view-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ViewList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "alias": "string", - "column": [ - { - "alias": "string", - "auto_increment": true, - "auto_update_timestamp": true, - "base_id": "string", - "character_maximum_length": "string", - "character_set_name": "string", - "colOptions": { - "deleted": "string", - "dr": "string", - "fk_child_column_id": "string", - "fk_column_id": "string", - "fk_index_name": "string", - "fk_mm_child_column_id": "string", - "fk_mm_model_id": "string", - "fk_mm_parent_column_id": "string", - "fk_parent_column_id": "string", - "id": "string", - "order": "string", - "type": "string", - "ur": "string", - "virtual": true - }, - "column_comment": "string", - "column_default": "string", - "column_ordinal_position": "string", - "column_type": "string", - "data_type": "string", - "data_type_x": "string", - "data_type_x_precision": "string", - "data_type_x_scale": "string", - "deleted": true, - "fk_model_id": "string", - "id": "string", - "numeric_precision": "string", - "numeric_scale": "string", - "order": 0, - "primary_key": true, - "primary_value": true, - "rqd": "string", - "title": "string", - "ui_data_type": "string", - "un": "string", - "unique": true, - "visible": true - } - ], - "columnByIds": {}, - "deleted": true, - "enabled": true, - "fk_base_id": "string", - "fk_project_id": "string", - "id": "string", - "order": 0, - "parent_id": "string", - "pinned": true, - "show_as": "string", - "tags": "string", - "title": "string", - "type": "string" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "description": "List all views in a given Table.", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/views/{viewId}": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "vw_wtdg2meyig5l4q" - }, - "name": "viewId", - "in": "path", - "required": true, - "description": "Unique View ID" - } - ], - "patch": { - "summary": "Update View", - "operationId": "db-view-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/View" - }, - "examples": { - "Example 1": { - "value": { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:46:31", - "fk_model_id": "md_mhs9z4r2ak98x0", - "id": "vw_lg052cnc1c26kf", - "is_default": 1, - "lock_type": "collaborative", - "meta": "{\"allowCSVDownload\":true}", - "order": 1, - "password": "password123", - "project_id": "p_xm3thidrblw4n7", - "show": 1, - "show_system_fields": null, - "title": "Grid View 1", - "type": 3, - "updated_at": "2023-03-02 17:46:31", - "uuid": null - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ViewUpdateReq" - }, - "examples": { - "Example 1": { - "value": { - "title": "Grid View 1", - "uuid": "e2457bbf-e29c-4fec-866e-fe3b01dba57f", - "password": "password123", - "lock_type": "collaborative", - "meta": "{\"allowCSVDownload\":true}", - "order": 1, - "show_system_fields": 0 - } - } - } - } - } - }, - "tags": ["DB View"], - "description": "Update the view with the given view Id.", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "delete": { - "summary": "Delete View", - "operationId": "db-view-delete", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "boolean" - }, - "examples": { - "Example 1": { - "value": true - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "description": "Delete the view with the given view Id.", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/views/{viewId}/show-all": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "vw_wtdg2meyig5l4q" - }, - "name": "viewId", - "in": "path", - "required": true, - "description": "Unique View ID" - } - ], - "post": { - "summary": "Show All Columns In View", - "operationId": "db-view-show-all-column", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "boolean" - }, - "examples": { - "Example 1": { - "value": true - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "description": "Show All Columns in a given View", - "parameters": [ - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "ignoreIds" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/views/{viewId}/hide-all": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "vw_wtdg2meyig5l4q" - }, - "name": "viewId", - "in": "path", - "required": true, - "description": "Unique View ID" - } - ], - "post": { - "summary": "Hide All Columns In View", - "operationId": "db-view-hide-all-column", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "boolean" - }, - "examples": { - "Example 1": { - "value": true - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "parameters": [ - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "ignoreIds" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "description": "Hide All Columns in a given View" - } - }, - "/api/v1/db/meta/tables/{tableId}/share": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "md_w9gpnaousnfss1", - "type": "string" - }, - "name": "tableId", - "in": "path", - "required": true, - "description": "Unique Table ID" - } - ], - "get": { - "summary": "List Shared Views", - "operationId": "db-view-share-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SharedViewList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:46:31", - "fk_model_id": "md_mhs9z4r2ak98x0", - "id": "vw_lg052cnc1c26kf", - "is_default": 1, - "lock_type": "collaborative", - "meta": {}, - "order": 1, - "project_id": "p_xm3thidrblw4n7", - "show": 1, - "show_system_fields": null, - "title": "Sheet-1", - "type": 3, - "updated_at": "2023-03-02 17:46:31", - "uuid": null, - "view": { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:46:31", - "fk_view_id": "vw_lg052cnc1c26kf", - "meta": null, - "project_id": "p_xm3thidrblw4n7", - "row_height": null, - "updated_at": "2023-03-02 17:46:31", - "uuid": null - } - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "List all shared views in a given Table", - "tags": ["DB View Share"], - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/views/{viewId}/share": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "vw_wtdg2meyig5l4q" - }, - "name": "viewId", - "in": "path", - "required": true, - "description": "Unique View ID" - } - ], - "post": { - "summary": "Create Shared View", - "operationId": "db-view-share-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SharedViewReq" - }, - "examples": { - "Example 1": { - "value": { - "meta": {}, - "password": "123456789" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View Share"], - "description": "Create a shared view in a given View..", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "patch": { - "summary": "Update Shared View", - "operationId": "db-view-share-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SharedView" - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SharedViewReq" - } - } - }, - "description": "" - }, - "tags": ["DB View Share"], - "description": "Update a shared view in a given View..", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "delete": { - "summary": "Delete Shared View", - "operationId": "db-view-share-delete", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "boolean" - }, - "examples": { - "Example 1": { - "value": true - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Delete a shared view in a given View.", - "tags": ["DB View Share"], - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/views/{viewId}/columns": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "vw_wtdg2meyig5l4q" - }, - "name": "viewId", - "in": "path", - "required": true, - "description": "Unique View ID" - } - ], - "get": { - "summary": "List Columns In View", - "operationId": "db-view-column-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ColumnList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "ai": 0, - "au": 0, - "base_id": "ds_krsappzu9f8vmo", - "cc": "", - "cdf": null, - "clen": "45", - "column_name": "title", - "cop": "2", - "created_at": "2023-03-02 13:14:16", - "csn": "utf8mb4", - "ct": "varchar(45)", - "deleted": null, - "dt": "varchar", - "dtx": "specificType", - "dtxp": "45", - "dtxs": null, - "fk_model_id": "md_yvwvbt2i78rgcm", - "id": "cl_0j9gv0oi8vjy46", - "meta": null, - "np": null, - "ns": null, - "order": 2, - "pk": 0, - "project_id": "p_01clqvzik3izk6", - "pv": 1, - "rqd": 0, - "system": 0, - "title": "Title", - "uidt": "SingleLineText", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 13:14:16", - "validate": null, - "virtual": null - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View Column"], - "description": "List all columns by ViewID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "post": { - "summary": "Create Column in View", - "operationId": "db-view-column-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Column" - }, - "examples": { - "Example 1": { - "value": { - "ai": 0, - "au": 0, - "base_id": "ds_krsappzu9f8vmo", - "cc": "", - "cdf": null, - "clen": "45", - "column_name": "title", - "cop": "2", - "created_at": "2023-03-02 13:14:16", - "csn": "utf8mb4", - "ct": "varchar(45)", - "deleted": null, - "dt": "varchar", - "dtx": "specificType", - "dtxp": "45", - "dtxs": null, - "fk_model_id": "md_yvwvbt2i78rgcm", - "id": "cl_0j9gv0oi8vjy46", - "meta": null, - "np": null, - "ns": null, - "order": 2, - "pk": 0, - "project_id": "p_01clqvzik3izk6", - "pv": 1, - "rqd": 0, - "system": 0, - "title": "Title", - "uidt": "SingleLineText", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 13:14:16", - "validate": null, - "virtual": null - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View Column"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ViewColumnReq" - }, - "examples": { - "Example 1": { - "value": { - "fk_column_id": "cl_m4wkaqgqqjzoeh", - "show": 0, - "order": 1 - } - } - } - } - } - }, - "description": "Create a new column in a given View", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/views/{viewId}/columns/{columnId}": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "vw_wtdg2meyig5l4q" - }, - "name": "viewId", - "in": "path", - "required": true - }, - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "cl_8iw2o4ejzvdyna", - "type": "string" - }, - "name": "columnId", - "in": "path", - "required": true, - "description": "Unique Column ID" - } - ], - "patch": { - "summary": "Update View Column", - "operationId": "db-view-column-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number" - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View Column"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ViewColumnUpdateReq" - }, - "examples": { - "Example 1": { - "value": { - "show": 0, - "order": 1 - } - } - } - } - } - }, - "description": "Update a column in a View", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/views/{viewId}/sorts": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "vw_wtdg2meyig5l4q" - }, - "name": "viewId", - "in": "path", - "required": true, - "description": "Unique View ID" - } - ], - "get": { - "summary": "List View Sorts", - "operationId": "db-table-sort-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SortList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "id": "so_xd4t51uv60ghzl", - "fk_column_id": "cl_l11b769pe2j1ce", - "fk_model_id": "md_ehn5izr99m7d45", - "base_id": "ds_3l9qx8xqksenrl", - "direction": "desc", - "order": 1, - "project_id": "p_9sx43moxhqtjm3" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Sort"], - "description": "List all the sort data in a given View", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "post": { - "summary": "Update View Sort", - "operationId": "db-table-sort-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number" - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Sort"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/SortReq" - }, - { - "type": "object", - "properties": { - "push_to_top": { - "type": "boolean", - "example": true, - "description": "Push the sort to the top of the list" - } - } - } - ] - } - } - } - }, - "description": "Update the sort data in a given View", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/sorts/{sortId}": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "so_xd4t51uv60ghzl" - }, - "name": "sortId", - "in": "path", - "description": "Unique Sort ID", - "required": true - } - ], - "get": { - "summary": "Get Sort", - "operationId": "db-table-sort-get", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Sort" - }, - "examples": { - "Example 1": { - "value": { - "id": "so_xd4t51uv60ghzl", - "fk_column_id": "cl_l11b769pe2j1ce", - "fk_model_id": "md_ehn5izr99m7d45", - "base_id": "ds_3l9qx8xqksenrl", - "direction": "desc", - "order": 1, - "project_id": "p_9sx43moxhqtjm3" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Sort"], - "description": "Get the sort data by Sort ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "patch": { - "summary": "Update Sort", - "operationId": "db-table-sort-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number", - "example": 1 - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Sort"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SortReq" - }, - "examples": { - "Example 1": { - "value": { - "direction": "asc", - "fk_column_id": "cl_l11b769pe2j1ce" - } - } - } - } - } - }, - "description": "Update the sort data by Sort ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "delete": { - "summary": "Delete Sort", - "operationId": "db-table-sort-delete", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "boolean" - }, - "examples": { - "Example 1": { - "value": true - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Sort"], - "description": "Delete the sort data by Sort ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/views/{viewId}/filters": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "vw_wtdg2meyig5l4q" - }, - "name": "viewId", - "in": "path", - "required": true, - "description": "Unique View ID" - } - ], - "get": { - "summary": "Get View Filter", - "operationId": "db-table-filter-read", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FilterList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "comparison_op": "eq", - "comparison_sub_op": null, - "created_at": "2023-03-02 18:18:05", - "fk_column_id": "cl_d7ah9n2qfupgys", - "fk_hook_id": null, - "fk_parent_id": null, - "fk_view_id": "vw_b739e29vqmrxnf", - "id": "fi_xn647tpmdq8fu8", - "is_group": null, - "logical_op": "and", - "order": 1, - "project_id": "p_xm3thidrblw4n7", - "updated_at": "2023-03-02 18:18:05", - "value": "foo" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Filter"], - "description": "Get the filter data in a given View", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "post": { - "summary": "Create View Filter", - "operationId": "db-table-filter-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Filter" - }, - "examples": { - "Example 1": { - "value": { - "base_id": "ds_g4ccx6e77h1dmi", - "comparison_op": "eq", - "comparison_sub_op": null, - "created_at": "2023-03-02 18:18:05", - "fk_column_id": "cl_d7ah9n2qfupgys", - "fk_hook_id": null, - "fk_parent_id": null, - "fk_view_id": "vw_b739e29vqmrxnf", - "id": "fi_xn647tpmdq8fu8", - "is_group": null, - "logical_op": "and", - "order": 1, - "project_id": "p_xm3thidrblw4n7", - "updated_at": "2023-03-02 18:18:05", - "value": "foo" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Filter"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FilterReq" - }, - "examples": { - "Example 1": { - "value": { - "comparison_op": "eq", - "comparison_sub_op": null, - "fk_column_id": "cl_d7ah9n2qfupgys", - "is_group": false, - "logical_op": "and", - "value": "foo" - } - } - } - } - } - }, - "description": "Update the filter data in a given View", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/hooks/{hookId}/filters": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "hk_0063k4o1frnxbr" - }, - "name": "hookId", - "in": "path", - "required": true, - "description": "Unique Hook ID" - } - ], - "get": { - "summary": "Get Hook Filter", - "operationId": "db-table-webhook-filter-read", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FilterList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "comparison_op": "eq", - "comparison_sub_op": null, - "created_at": "2023-03-02 18:18:05", - "fk_column_id": "cl_d7ah9n2qfupgys", - "fk_hook_id": null, - "fk_parent_id": null, - "fk_view_id": "vw_b739e29vqmrxnf", - "id": "fi_xn647tpmdq8fu8", - "is_group": null, - "logical_op": "and", - "order": 1, - "project_id": "p_xm3thidrblw4n7", - "updated_at": "2023-03-02 18:18:05", - "value": "foo" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Webhook Filter"], - "description": "Get the filter data in a given Hook", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "post": { - "summary": "Create Hook Filter", - "operationId": "db-table-webhook-filter-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Filter" - }, - "examples": { - "Example 1": { - "value": { - "base_id": "ds_g4ccx6e77h1dmi", - "comparison_op": "eq", - "comparison_sub_op": null, - "created_at": "2023-03-02 18:18:05", - "fk_column_id": "cl_d7ah9n2qfupgys", - "fk_hook_id": null, - "fk_parent_id": null, - "fk_view_id": "vw_b739e29vqmrxnf", - "id": "fi_xn647tpmdq8fu8", - "is_group": null, - "logical_op": "and", - "order": 1, - "project_id": "p_xm3thidrblw4n7", - "updated_at": "2023-03-02 18:18:05", - "value": "foo" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Webhook Filter"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FilterReq" - }, - "examples": { - "Example 1": { - "value": { - "comparison_op": "eq", - "comparison_sub_op": null, - "fk_column_id": "cl_d7ah9n2qfupgys", - "is_group": false, - "logical_op": "and", - "value": "foo" - } - } - } - } - } - }, - "description": "Create filter(s) in a given Hook", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/hooks/{hookId}/logs": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "hk_0063k4o1frnxbr" - }, - "name": "hookId", - "in": "path", - "required": true, - "description": "Unique Hook ID" - } - ], - "get": { - "summary": "List Hook Logs", - "operationId": "db-table-webhook-logs-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HookLogList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "base_id": "ds_jxuewivwbxeum2", - "event": "after", - "execution_time": "98", - "fk_hook_id": "hk_035ijv5qdi97y5", - "id": "string", - "notifications": "{\"type\":\"URL\",\"payload\":{\"method\":\"POST\",\"body\":\"{{ json data }}\",\"headers\":[{}],\"parameters\":[{}],\"auth\":\"\",\"path\":\"https://webhook.site/6eb45ce5-b611-4be1-8b96-c2965755662b\"}}", - "operation": "insert", - "payload": "{\"method\":\"POST\",\"body\":\"{{ json data }}\",\"headers\":[{}],\"parameters\":[{}],\"auth\":\"\",\"path\":\"https://webhook.site/6eb45ce5-b611-4be1-8b96-c2965755662b\"}", - "project_id": "p_tbhl1hnycvhe5l", - "response": "{\"status\":200,\"statusText\":\"OK\",\"headers\":{\"server\":\"nginx\",\"content-type\":\"text/plain; charset=UTF-8\",\"transfer-encoding\":\"chunked\",\"connection\":\"close\",\"vary\":\"Accept-Encoding\",\"x-request-id\":\"53844a7d-ede8-4798-adf7-8af441908a72\",\"x-token-id\":\"6eb45ce5-b611-4be1-8b96-c2965755662b\",\"cache-control\":\"no-cache, private\",\"date\":\"Fri, 24 Mar 2023 10:50:10 GMT\"},\"config\":{\"url\":\"https://webhook.site/6eb45ce5-b611-4be1-8b96-c2965755662b\",\"method\":\"post\",\"data\":\"{\\\"type\\\":\\\"records.after.insert\\\",\\\"id\\\":\\\"a77d97dc-a3e4-4719-9b46-45f93e0cc99a\\\",\\\"data\\\":{\\\"table_id\\\":\\\"md_d8v403o74mf5lf\\\",\\\"table_name\\\":\\\"Sheet-2\\\"}}\",\"headers\":{\"Accept\":\"application/json, text/plain, */*\",\"Content-Type\":\"application/x-www-form-urlencoded\",\"User-Agent\":\"axios/0.21.4\",\"Content-Length\":138},\"params\":{}}}", - "test_call": 0, - "triggered_by": "w@nocodb.com", - "type": "URL" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Webhook Logs"], - "description": "List the log data in a given Hook", - "parameters": [ - { - "schema": { - "type": "integer", - "minimum": 1 - }, - "in": "query", - "name": "limit" - }, - { - "schema": { - "type": "integer", - "minimum": 0 - }, - "in": "query", - "name": "offset" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/filters/{filterId}": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "pattern": "fi_pgfuo11uhn2xeo" - }, - "name": "filterId", - "in": "path", - "required": true, - "description": "Unique Filter ID" - } - ], - "get": { - "summary": "Get Filter", - "operationId": "db-table-filter-get", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Filter" - }, - "examples": { - "Example 1": { - "value": { - "base_id": "ds_g4ccx6e77h1dmi", - "comparison_op": "eq", - "comparison_sub_op": null, - "created_at": "2023-03-02 18:18:05", - "fk_column_id": "cl_d7ah9n2qfupgys", - "fk_hook_id": null, - "fk_parent_id": null, - "fk_view_id": "vw_b739e29vqmrxnf", - "id": "fi_xn647tpmdq8fu8", - "is_group": null, - "logical_op": "and", - "order": 1, - "project_id": "p_xm3thidrblw4n7", - "updated_at": "2023-03-02 18:18:05", - "value": "foo" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Filter"], - "description": "Get the filter data with a given Filter ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "patch": { - "summary": "Update Filter", - "operationId": "db-table-filter-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number" - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Filter"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FilterReq" - }, - "examples": { - "Example 1": { - "value": { - "comparison_op": "eq", - "comparison_sub_op": null, - "fk_column_id": "cl_d7ah9n2qfupgys", - "is_group": false, - "logical_op": "and", - "value": "foo" - } - } - } - } - } - }, - "description": "Update the filter data with a given Filter ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "delete": { - "summary": "Delete Filter", - "operationId": "db-table-filter-delete", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "boolean" - }, - "examples": { - "Example 1": { - "value": true - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Filter"], - "description": "Delete the filter data with a given Filter ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/filters/{filterGroupId}/children": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "fi_pgfuo11uhn2xeo", - "description": "Filter Group ID" - }, - "name": "filterGroupId", - "in": "path", - "required": true - } - ], - "get": { - "summary": "Get Filter Group Children", - "operationId": "db-table-filter-children-read", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FilterList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "comparison_op": "eq", - "comparison_sub_op": null, - "created_at": "2023-03-02 18:18:05", - "fk_column_id": "cl_d7ah9n2qfupgys", - "fk_hook_id": null, - "fk_parent_id": null, - "fk_view_id": "vw_b739e29vqmrxnf", - "id": "fi_xn647tpmdq8fu8", - "is_group": null, - "logical_op": "and", - "order": 1, - "project_id": "p_xm3thidrblw4n7", - "updated_at": "2023-03-02 18:18:05", - "value": "foo" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Filter"], - "description": "Get Filter Group Children of a given group ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/tables/{tableId}/grids": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "md_w9gpnaousnfss1", - "type": "string" - }, - "name": "tableId", - "in": "path", - "required": true, - "description": "Unique Table ID" - } - ], - "post": { - "summary": "Create Grid View", - "operationId": "db-view-grid-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/View" - }, - "examples": { - "Example 1": { - "value": { - "id": "vw_o50jiw9v2txktv", - "base_id": "ds_a95vextjl510z7", - "project_id": "p_slkm6i3v31q4bc", - "fk_model_id": "md_8hr3xndx8umuce", - "title": "Grid-1", - "type": 3, - "is_default": null, - "show_system_fields": null, - "lock_type": "collaborative", - "uuid": null, - "password": null, - "show": true, - "order": 2, - "created_at": "2023-03-13T07:29:16.610Z", - "updated_at": "2023-03-13T07:29:16.610Z", - "meta": {} - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ViewCreateReq" - }, - "examples": { - "Example 1": { - "value": { - "title": "My Grid View", - "type": 3, - "copy_from_id": null, - "fk_grp_col_id": null, - "fk_geo_data_col_id": null - } - } - } - } - } - }, - "description": "Create a new grid view in a given Table", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/tables/{tableId}/forms": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "md_w9gpnaousnfss1", - "type": "string" - }, - "name": "tableId", - "in": "path", - "required": true, - "description": "Unique Table ID" - } - ], - "post": { - "summary": "Create Form View", - "operationId": "db-view-form-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/View" - }, - "examples": { - "Example 1": { - "value": { - "id": "vw_a830n4bmwk8wlp", - "base_id": "ds_a95vextjl510z7", - "project_id": "p_slkm6i3v31q4bc", - "fk_model_id": "md_8hr3xndx8umuce", - "title": "Form-1", - "type": 1, - "is_default": null, - "show_system_fields": null, - "lock_type": "collaborative", - "uuid": null, - "password": null, - "show": true, - "order": 4, - "created_at": "2023-03-13T07:29:19.957Z", - "updated_at": "2023-03-13T07:29:19.957Z", - "meta": {} - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Create a new form view in a given Table", - "tags": ["DB View"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ViewCreateReq" - }, - "examples": { - "Example 1": { - "value": { - "title": "My Form View", - "type": 1, - "copy_from_id": null, - "fk_grp_col_id": null, - "fk_geo_data_col_id": null - } - } - } - } - } - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/forms/{formViewId}": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "vw_6fqln9vdytdv8q" - }, - "name": "formViewId", - "in": "path", - "required": true, - "description": "Unique Form View ID" - } - ], - "patch": { - "summary": "Update Form View", - "operationId": "db-view-form-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number" - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FormUpdateReq" - }, - "examples": { - "Example 1": { - "value": { - "banner_image_url": null, - "email": "user@example.com", - "heading": "My Form", - "lock_type": "collaborative", - "logo_url": null, - "meta": null, - "redirect_after_secs": null, - "redirect_url": null, - "show_blank_form": 0, - "subheading": "My Form Subheading", - "submit_another_form": 0, - "success_msg": "Thank you for the submission.", - "title": "Form View 1" - } - } - } - } - } - }, - "description": "Update the form data by Form ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "get": { - "summary": "Get Form", - "operationId": "db-view-form-read", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Form" - }, - "examples": { - "Example 1": { - "value": { - "base_id": "ds_g4ccx6e77h1dmi", - "banner_image_url": null, - "columns": [ - { - "id": "fvc_ugj9zo5bzocxtl", - "base_id": "ds_g4ccx6e77h1dmi", - "project_id": "p_xm3thidrblw4n7", - "fk_view_id": "vw_kdf5cr7qmhksek", - "fk_column_id": "cl_phvuuwjrzcdo0g", - "uuid": null, - "label": null, - "help": null, - "description": null, - "required": null, - "show": 0, - "order": 1, - "created_at": "2023-03-04 16:40:47", - "updated_at": "2023-03-04 16:40:47", - "meta": {} - } - ], - "email": "user@example.com", - "fk_model_id": "md_rsu68aqjsbyqtl", - "heading": "My Form", - "lock_type": "collaborative", - "logo_url": null, - "meta": null, - "redirect_after_secs": null, - "redirect_url": null, - "show_blank_form": 0, - "subheading": "My Form Subheading", - "submit_another_form": 0, - "success_msg": "Thank you for the submission.", - "title": "Form View 1" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "description": "Get the form data by Form ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/form-columns/{formViewColumnId}": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "fvc_1m9b0aub791d4m", - "type": "string" - }, - "name": "formViewColumnId", - "in": "path", - "required": true, - "description": "Unique Form View Column ID" - } - ], - "patch": { - "summary": "Update Form Column", - "operationId": "db-view-form-column-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FormColumnReq" - }, - "examples": { - "Example 1": { - "value": { - "description": null, - "help": "This is a help text", - "label": "Form Label", - "meta": null, - "order": 1, - "required": 0, - "show": 0 - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FormColumnReq" - } - } - } - }, - "description": "Update the form column(s) by Form View Column ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/grids/{viewId}": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "vw_wtdg2meyig5l4q" - }, - "name": "viewId", - "in": "path", - "required": true, - "description": "Unique View ID" - } - ], - "patch": { - "summary": "Update Grid View", - "operationId": "db-view-grid-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number" - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GridUpdateReq" - }, - "examples": { - "Example 1": { - "value": { - "row_height": 1, - "meta": null - } - } - } - } - } - }, - "description": "Update Grid View", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/grids/{gridId}/grid-columns": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "vw_q6k13mmygdi3yz" - }, - "name": "gridId", - "in": "path", - "required": true, - "description": "Grid View ID" - } - ], - "get": { - "summary": "List Grid Columns", - "operationId": "db-view-grid-columns-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GridColumn" - } - }, - "examples": { - "Example 1": { - "value": [ - { - "id": "nc_c8jz4kxe6xvh11", - "fk_view_id": "vw_p2jcatxz4mvcfw", - "fk_column_id": "cl_c5knoi4xs4sfpt", - "project_id": "p_xm3thidrblw4n7", - "base_id": "ds_g4ccx6e77h1dmi", - "show": 0, - "order": 1, - "width": "200px", - "help": null - } - ] - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "description": "List all columns in the given Grid", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/grid-columns/{columnId}": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "cl_8iw2o4ejzvdyna", - "type": "string" - }, - "name": "columnId", - "in": "path", - "required": true, - "description": "Unique Column ID" - } - ], - "patch": { - "summary": "Update Grid Column", - "operationId": "db-view-grid-column-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number" - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GridColumnReq" - }, - "examples": { - "Example 1": { - "value": { - "fk_column_id": "cl_c5knoi4xs4sfpt", - "label": "My Column", - "width": "200px" - } - } - } - } - } - }, - "description": "Update grid column(s) in the given Grid", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/tables/{tableId}/galleries": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "md_w9gpnaousnfss1" - }, - "name": "tableId", - "in": "path", - "required": true, - "description": "Unique Table ID" - } - ], - "post": { - "summary": "Create Gallery View", - "operationId": "db-view-gallery-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/View" - }, - "examples": { - "Example 1": { - "value": { - "id": "vw_qp94qfnvffgk5f", - "base_id": "ds_a95vextjl510z7", - "project_id": "p_slkm6i3v31q4bc", - "fk_model_id": "md_8hr3xndx8umuce", - "title": "Gallery-1", - "type": 2, - "is_default": null, - "show_system_fields": null, - "lock_type": "collaborative", - "uuid": null, - "password": null, - "show": true, - "order": 3, - "created_at": "2023-03-13T07:29:18.707Z", - "updated_at": "2023-03-13T07:29:18.707Z", - "meta": {} - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ViewCreateReq" - }, - "examples": { - "Example 1": { - "value": { - "title": "My Gallery View", - "type": 2, - "copy_from_id": null, - "fk_grp_col_id": null, - "fk_geo_data_col_id": null - } - } - } - } - } - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/galleries/{galleryViewId}": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "vw_1eq2wk2xe3a9j5" - }, - "name": "galleryViewId", - "in": "path", - "required": true, - "description": "Unique Gallery View ID" - } - ], - "patch": { - "summary": "Update Gallery View", - "operationId": "db-view-gallery-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number" - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GalleryUpdateReq" - }, - "examples": { - "Example 1": { - "value": { - "fk_cover_image_col_id": "cl_ib8l4j1kiu1efx", - "meta": null - } - } - } - } - } - }, - "description": "Update the Gallery View data with Gallery ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "get": { - "summary": "Get Gallery View", - "operationId": "db-view-gallery-read", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Gallery" - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "description": "Get the Gallery View data with Gallery ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/tables/{tableId}/kanbans": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "md_w9gpnaousnfss1", - "type": "string" - }, - "name": "tableId", - "in": "path", - "required": true, - "description": "Unique Table ID" - } - ], - "post": { - "summary": "Create Kanban View", - "operationId": "db-view-kanban-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/View" - }, - "examples": { - "Example 1": { - "value": { - "id": "vw_569sqsrp2vuff4", - "base_id": "ds_a95vextjl510z7", - "project_id": "p_slkm6i3v31q4bc", - "fk_model_id": "md_8hr3xndx8umuce", - "title": "Kanban-1", - "type": 4, - "is_default": null, - "show_system_fields": null, - "lock_type": "collaborative", - "uuid": null, - "password": null, - "show": true, - "order": 5, - "created_at": "2023-03-13T07:29:21.387Z", - "updated_at": "2023-03-13T07:29:21.387Z", - "meta": {} - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ViewCreateReq" - }, - "examples": { - "Example 1": { - "value": { - "title": "My Kanban View", - "type": 4, - "copy_from_id": null, - "fk_grp_col_id": "cl_g0a89q9xdry3lu", - "fk_geo_data_col_id": null - } - } - } - } - } - }, - "description": "Create a new Kanban View", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/kanbans/{kanbanViewId}": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "vw_1eq2wk2xe3a9j5" - }, - "name": "kanbanViewId", - "in": "path", - "required": true, - "description": "Unique Kanban View ID" - } - ], - "patch": { - "summary": "Update Kanban View", - "operationId": "db-view-kanban-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number" - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/KanbanUpdateReq" - }, - "examples": { - "Example 1": { - "value": { - "fk_grp_col_id": "cl_g0a89q9xdry3lu", - "fk_cover_image_col_id": "cl_ib8l4j1kiu1efx", - "meta": { - "cl_g0a89q9xdry3lu": [ - { - "id": "uncategorized", - "title": null, - "order": 0, - "color": "#c2f5e8", - "collapsed": false - }, - { - "id": "sl_ihyva6jx6dg0fc", - "fk_column_id": "cl_g0a89q9xdry3lu", - "title": "a", - "color": "#cfdffe", - "order": 1, - "collapsed": false - }, - { - "id": "sl_gqdm5v6t8aetoa", - "fk_column_id": "cl_g0a89q9xdry3lu", - "title": "b", - "color": "#d0f1fd", - "order": 2, - "collapsed": false - }, - { - "id": "sl_eipnl0kn7a9d3c", - "fk_column_id": "cl_g0a89q9xdry3lu", - "title": "cc", - "color": "#c2f5e8", - "order": 3, - "collapsed": false - }, - { - "id": "sl_dei8p2jq0cnlv0", - "fk_column_id": "cl_g0a89q9xdry3lu", - "title": "d", - "color": "#ffdaf6", - "order": 4, - "collapsed": false - } - ] - } - } - } - } - } - } - }, - "description": "Update the Kanban View data with Kanban ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "get": { - "summary": "Get Kanban View", - "operationId": "db-view-kanban-read", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Kanban" - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "description": "Get the Kanban View data by Kanban ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/tables/{tableId}/maps": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "md_w9gpnaousnfss1", - "type": "string" - }, - "name": "tableId", - "in": "path", - "required": true, - "description": "Unique Table ID" - } - ], - "post": { - "summary": "Create Map View", - "operationId": "db-view-map-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/View" - }, - "examples": { - "Example 1": { - "value": { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:46:31", - "fk_model_id": "md_mhs9z4r2ak98x0", - "id": "vw_lg052cnc1c26kf", - "is_default": 1, - "lock_type": "collaborative", - "meta": {}, - "order": 1, - "password": null, - "project_id": "p_xm3thidrblw4n7", - "show": 1, - "show_system_fields": null, - "title": "Sheet-1", - "type": 3, - "updated_at": "2023-03-02 17:46:31", - "uuid": null - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ViewCreateReq" - }, - "examples": { - "Example 1": { - "value": { - "title": "My Map View", - "type": 5, - "copy_from_id": null, - "fk_grp_col_id": null, - "fk_geo_data_col_id": "cl_uu1meolj00tlrq" - } - } - } - } - }, - "description": "" - }, - "description": "Create a new Map View", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/maps/{mapViewId}": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "vw_1eq2wk2xe3a9j5" - }, - "name": "mapViewId", - "in": "path", - "required": true, - "description": "Unique Map View ID" - } - ], - "patch": { - "summary": "Update Map View", - "operationId": "db-view-map-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number" - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/MapUpdateReq" - }, - "examples": { - "Example 1": { - "value": { - "fk_geo_data_col_id": "cl_8iw2o4ejzvdyna", - "meta": null - } - } - } - } - } - }, - "description": "Update the Map View data by Map ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "get": { - "summary": "Get Map View", - "operationId": "db-view-map-read", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Map" - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "description": "Get the Map View data by Map ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/projects/{projectId}/meta-diff": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - } - ], - "post": { - "summary": "Sync Meta", - "operationId": "project-meta-diff-sync", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "la6fd99uw6eao" - }, - "example": "The meta has been synchronized successfully" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "The meta has been synchronized successfully" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Project"], - "description": "Synchronise the meta data difference between NC_DB and external data sources ", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "get": { - "summary": "Meta Diff", - "operationId": "project-meta-diff-get", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["Project"], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "x-stoplight": { - "id": "awdkjwr7uultr" - }, - "type": "object", - "properties": { - "table_name": { - "type": "string", - "x-stoplight": { - "id": "jjj8ufafq1sd2" - }, - "description": "Table Name", - "example": "Table 1" - }, - "base_id": { - "type": "string", - "x-stoplight": { - "id": "smx2or6bv1xym" - }, - "description": "Base ID", - "example": "ds_rrplkgy0pq1f3c" - }, - "type": { - "type": "string", - "x-stoplight": { - "id": "zr19ahh1s6d13" - }, - "description": "Change Type", - "example": "table" - }, - "detectedChanges": { - "type": "array", - "x-stoplight": { - "id": "bptxla2y27aq6" - }, - "description": "Detected Changes", - "items": { - "x-stoplight": { - "id": "ob16o1ln7xy8o" - }, - "type": "object" - } - } - } - } - }, - "examples": { - "Example 1": { - "value": [ - { - "table_name": "_nc_m2m_uuv_xzru3m", - "base_id": "ds_rrplkgy0pq1f3c", - "type": "table", - "detectedChanges": [ - { - "type": "TABLE_NEW", - "msg": "New table" - }, - { - "type": "TABLE_RELATION_ADD", - "tn": "_nc_m2m_uuv_xzru3m", - "rtn": "Sheet-1", - "cn": "table1_id", - "rcn": "id", - "msg": "New relation added", - "relationType": "bt", - "cstn": "_nc_m2m_uuv_xzru3m_table1_id_foreign" - }, - { - "type": "TABLE_RELATION_ADD", - "tn": "_nc_m2m_uuv_xzru3m", - "rtn": "address", - "cn": "table2_id", - "rcn": "address_id", - "msg": "New relation added", - "relationType": "bt", - "cstn": "_nc_m2m_uuv_xzru3m_table2_id_foreign" - } - ] - } - ] - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Get the meta data difference between NC_DB and external data sources " - } - }, - "/api/v1/db/meta/projects/{projectId}/meta-diff/{baseId}": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - }, - { - "schema": { - "type": "string", - "pattern": "ds_j04jmxh5xg10lu" - }, - "name": "baseId", - "in": "path", - "required": true, - "description": "Unique Base ID" - } - ], - "post": { - "summary": "Synchronise Base Meta", - "operationId": "base-meta-diff-sync", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "acy7tx4rounqw" - }, - "example": "The base meta has been synchronized successfully" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "The base meta has been synchronized successfully" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Base"], - "description": "Synchronise the meta data difference between NC_DB and external data sources in a given Base", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "get": { - "summary": "Base Meta Diff", - "operationId": "base-meta-diff-get", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["Base"], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "x-stoplight": { - "id": "pav4jmel1ebeu" - }, - "type": "object", - "properties": { - "table_name": { - "type": "string", - "x-stoplight": { - "id": "xjw4k4httzmaf" - }, - "description": "Table Name", - "example": "Table 1" - }, - "base_id": { - "type": "string", - "x-stoplight": { - "id": "l1o3qhkgagsdl" - }, - "example": "ds_rrplkgy0pq1f3c", - "description": "Base ID" - }, - "type": { - "type": "string", - "x-stoplight": { - "id": "v5ciaygrj64uh" - }, - "description": "Change Type", - "example": "table" - }, - "detectedChanges": { - "type": "array", - "x-stoplight": { - "id": "wqn5noi0e46q8" - }, - "description": "Detected Changes", - "items": { - "x-stoplight": { - "id": "r2roo274wquvf" - }, - "type": "object" - } - } - } - } - }, - "examples": { - "Example 1": { - "value": [ - { - "table_name": "_nc_m2m_uuv_xzru3m", - "base_id": "ds_rrplkgy0pq1f3c", - "type": "table", - "detectedChanges": [ - { - "type": "TABLE_NEW", - "msg": "New table" - }, - { - "type": "TABLE_RELATION_ADD", - "tn": "_nc_m2m_uuv_xzru3m", - "rtn": "Sheet-1", - "cn": "table1_id", - "rcn": "id", - "msg": "New relation added", - "relationType": "bt", - "cstn": "_nc_m2m_uuv_xzru3m_table1_id_foreign" - }, - { - "type": "TABLE_RELATION_ADD", - "tn": "_nc_m2m_uuv_xzru3m", - "rtn": "address", - "cn": "table2_id", - "rcn": "address_id", - "msg": "New relation added", - "relationType": "bt", - "cstn": "_nc_m2m_uuv_xzru3m_table2_id_foreign" - } - ] - } - ] - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Get the meta data difference between NC_DB and external data sources in a given Base" - } - }, - "/api/v1/db/meta/projects/{projectId}/has-empty-or-null-filters": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - } - ], - "get": { - "summary": "List Empty & Null Filter", - "operationId": "project-has-empty-or-null-filters", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["Project"], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": {} - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Check if a project contains empty and null filters. Used in `Show NULL and EMPTY in Filter` in Project Setting.", - "x-internal": true - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - } - ], - "get": { - "summary": "List Table Rows", - "operationId": "db-table-row-list", - "description": "List all table rows in a given table and project", - "tags": ["DB Table Row"], - "parameters": [ - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "fields", - "description": "Which fields to be shown" - }, - { - "schema": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "type": "string" - } - ] - }, - "in": "query", - "name": "sort", - "description": "The result will be sorted based on `sort` query" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where", - "description": "Extra filtering" - }, - { - "schema": { - "type": "integer", - "minimum": 0 - }, - "in": "query", - "name": "offset", - "description": "Offset in rows" - }, - { - "schema": { - "type": "integer", - "minimum": 1 - }, - "in": "query", - "name": "limit", - "description": "Limit in rows" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "sortArrJson", - "description": "Used for multiple sort queries" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "filterArrJson", - "description": "Used for multiple filter queries" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "list": { - "type": "array", - "x-stoplight": { - "id": "g92aqxk869a7o" - }, - "description": "List of data objects", - "items": { - "x-stoplight": { - "id": "rnbt8ubciknfd" - }, - "type": "object" - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated", - "x-stoplight": { - "id": "7f38yyzdg03x5" - }, - "description": "Paginated Info" - } - }, - "required": ["list", "pageInfo"] - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "Id": 1, - "Title": "baz", - "SingleSelect": null, - "Sheet-1 List": [ - { - "Id": 1, - "Title": "baz" - } - ], - "LTAR": [ - { - "Id": 1, - "Title": "baz" - } - ] - }, - { - "Id": 2, - "Title": "foo", - "SingleSelect": "a", - "Sheet-1 List": [ - { - "Id": 2, - "Title": "foo" - } - ], - "LTAR": [ - { - "Id": 2, - "Title": "foo" - } - ] - }, - { - "Id": 3, - "Title": "bar", - "SingleSelect": "b", - "Sheet-1 List": [], - "LTAR": [] - } - ], - "pageInfo": { - "totalRows": 3, - "page": 1, - "pageSize": 25, - "isFirstPage": true, - "isLastPage": true - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - } - }, - "post": { - "summary": "Create Table Row", - "operationId": "db-table-row-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": {} - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Row"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "examples": { - "Example 1": { - "value": { - "Id": 1, - "Title": "foo", - "CreatedAt": "2023-03-11T09:10:53.567Z", - "UpdatedAt": "2023-03-11T09:10:53.567Z" - } - } - } - } - } - }, - "description": "Create a new row in a given table and project.", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/find-one": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - } - ], - "get": { - "summary": "Find One Table Row", - "operationId": "db-table-row-find-one", - "description": "Return the first result of the target Table Row", - "tags": ["DB Table Row"], - "parameters": [ - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "fields" - }, - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "sort" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "examples": { - "Example 1": { - "value": { - "Id": 1, - "Title": "foo", - "CreatedAt": "2023-03-11T09:10:53.567Z", - "UpdatedAt": "2023-03-11T09:10:53.567Z" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - } - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/groupby": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "column_name", - "description": "Column name of the column you want to group by, eg. `column_name=column1`" - } - ], - "get": { - "summary": "Group By Table Row", - "operationId": "db-table-row-group-by", - "description": "Get the result grouped by the given query", - "tags": ["DB Table Row"], - "parameters": [ - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "sort" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where" - }, - { - "schema": { - "type": "integer", - "minimum": 1 - }, - "in": "query", - "name": "limit" - }, - { - "schema": { - "type": "integer", - "minimum": 0 - }, - "in": "query", - "name": "offset" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": {} - } - } - } - } - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/views/{viewName}/group/{columnId}": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string", - "example": "p_tbhl1hnycvhe5l" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string", - "example": "md_5hua2iqloqirhd" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "type": "string", - "example": "vw_mldv0a5mtwh1la" - }, - "name": "viewName", - "in": "path", - "required": true, - "description": "View Name" - }, - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "cl_8iw2o4ejzvdyna", - "type": "string" - }, - "name": "columnId", - "in": "path", - "required": true, - "description": "Unique Column ID" - } - ], - "get": { - "summary": "Table Group by Column", - "operationId": "db-view-row-grouped-data-list", - "description": "Get the grouped data By Column ID. Used in Kanban View.", - "tags": ["DB View Row"], - "parameters": [ - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "fields" - }, - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "sort" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where" - }, - { - "schema": {}, - "in": "query", - "name": "nested", - "description": "Query params for nested data" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": {} - }, - "examples": { - "Example 1": { - "value": [ - { - "key": "a", - "value": { - "list": [ - { - "Id": 2, - "Title": "foo", - "SingleSelect": "a" - } - ], - "pageInfo": { - "totalRows": 1, - "page": 1, - "pageSize": 25, - "isFirstPage": true, - "isLastPage": true - } - } - }, - { - "key": "b", - "value": { - "list": [ - { - "Id": 3, - "Title": "bar", - "SingleSelect": "b" - } - ], - "pageInfo": { - "totalRows": 1, - "page": 1, - "pageSize": 25, - "isFirstPage": true, - "isLastPage": true - } - } - }, - { - "key": null, - "value": { - "list": [ - { - "Id": 1, - "Title": "baz", - "SingleSelect": null - }, - { - "Id": 5, - "Title": "xyz", - "SingleSelect": null - } - ], - "pageInfo": { - "totalRows": 2, - "page": 1, - "pageSize": 25, - "isFirstPage": true, - "isLastPage": true - } - } - } - ] - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - } - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/group/{columnId}": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string", - "example": "p_tbhl1hnycvhe5l" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string", - "example": "md_5hua2iqloqirhd" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "cl_8iw2o4ejzvdyna", - "type": "string" - }, - "name": "columnId", - "in": "path", - "required": true, - "description": "Unique Column ID" - } - ], - "get": { - "summary": "Table Group by Column", - "operationId": "db-table-row-grouped-data-list", - "description": "Get the grouped data By Column ID. Used in Kanban View.", - "tags": ["DB Table Row"], - "parameters": [ - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "fields" - }, - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "sort" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where" - }, - { - "schema": {}, - "in": "query", - "name": "nested", - "description": "Query params for nested data" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": {} - }, - "examples": { - "Example 1": { - "value": [ - { - "key": "a", - "value": { - "list": [ - { - "Id": 2, - "Title": "foo", - "SingleSelect": "a" - } - ], - "pageInfo": { - "totalRows": 1, - "page": 1, - "pageSize": 25, - "isFirstPage": true, - "isLastPage": true - } - } - }, - { - "key": "b", - "value": { - "list": [ - { - "Id": 3, - "Title": "bar", - "SingleSelect": "b" - } - ], - "pageInfo": { - "totalRows": 1, - "page": 1, - "pageSize": 25, - "isFirstPage": true, - "isLastPage": true - } - } - }, - { - "key": null, - "value": { - "list": [ - { - "Id": 1, - "Title": "baz", - "SingleSelect": null - }, - { - "Id": 5, - "Title": "xyz", - "SingleSelect": null - } - ], - "pageInfo": { - "totalRows": 2, - "page": 1, - "pageSize": 25, - "isFirstPage": true, - "isLastPage": true - } - } - } - ] - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - } - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/views/{viewName}": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "type": "string" - }, - "name": "viewName", - "in": "path", - "required": true - } - ], - "get": { - "summary": "List Table View Rows", - "operationId": "db-view-row-list", - "description": "List all table view rows", - "tags": ["DB View Row"], - "parameters": [ - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "fields" - }, - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "sort" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where" - }, - { - "schema": {}, - "in": "query", - "name": "nested", - "description": "Query params for nested data" - }, - { - "schema": { - "type": "number" - }, - "in": "query", - "name": "offset" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "list": { - "type": "array", - "x-stoplight": { - "id": "okd8utzm9xqet" - }, - "description": "List of table view rows", - "items": { - "x-stoplight": { - "id": "j758lsjv53o4q" - }, - "type": "object" - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated", - "x-stoplight": { - "id": "hylgqzgm8yhye" - }, - "description": "Paginated Info" - } - }, - "required": ["list", "pageInfo"] - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "Id": 1, - "Title": "baz", - "SingleSelect": null, - "Sheet-1 List": [ - { - "Id": 1, - "Title": "baz" - } - ], - "LTAR": [ - { - "Id": 1, - "Title": "baz" - } - ] - }, - { - "Id": 2, - "Title": "foo", - "SingleSelect": "a", - "Sheet-1 List": [ - { - "Id": 2, - "Title": "foo" - } - ], - "LTAR": [ - { - "Id": 2, - "Title": "foo" - } - ] - }, - { - "Id": 3, - "Title": "bar", - "SingleSelect": "b", - "Sheet-1 List": [], - "LTAR": [] - } - ], - "pageInfo": { - "totalRows": 3, - "page": 1, - "pageSize": 25, - "isFirstPage": true, - "isLastPage": true - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - } - }, - "post": { - "summary": "Create Table View Row", - "operationId": "db-view-row-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "examples": { - "Example 1": { - "value": { - "Id": 1, - "col1": "foo", - "col2": "bar", - "CreatedAt": "2023-03-11T08:48:25.598Z", - "UpdatedAt": "2023-03-11T08:48:25.598Z" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View Row"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "examples": { - "Example 1": { - "value": { - "col1": "foo", - "col2": "bar" - } - } - } - } - } - }, - "description": "Create a new row in the given Table View" - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/views/{viewName}/find-one": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "type": "string" - }, - "name": "viewName", - "in": "path", - "required": true - } - ], - "get": { - "summary": "Find One Table View Row", - "operationId": "db-view-row-find-one", - "description": "Return the first result of table view rows with the given query", - "tags": ["DB View Row"], - "parameters": [ - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "fields" - }, - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "sort" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where" - }, - { - "schema": {}, - "in": "query", - "name": "nested", - "description": "Query params for nested data" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "examples": { - "Example 1": { - "value": { - "Id": 1, - "Title": "foo", - "CreatedAt": "2023-03-11T09:10:53.567Z", - "UpdatedAt": "2023-03-11T09:10:53.567Z" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - } - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/views/{viewName}/groupby": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "type": "string" - }, - "name": "viewName", - "in": "path", - "required": true - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "column_name", - "description": "Column name of the column you want to group by, eg. `column_name=column1`" - } - ], - "get": { - "summary": "Group By Table View Row", - "operationId": "db-view-row-group-by", - "description": "Get the table view rows groupe by the given query", - "tags": ["DB View Row"], - "parameters": [ - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "sort" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where" - }, - { - "schema": { - "type": "integer", - "minimum": 1 - }, - "in": "query", - "name": "limit" - }, - { - "schema": { - "type": "integer", - "minimum": 0 - }, - "in": "query", - "name": "offset" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": {} - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - } - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/views/{viewName}/count": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "type": "string", - "example": "vw_75neroyqdye94k" - }, - "name": "viewName", - "in": "path", - "required": true, - "description": "View Name" - } - ], - "get": { - "summary": "Count Table View Rows", - "operationId": "db-view-row-count", - "description": "Count how many rows in the given Table View", - "tags": ["DB View Row"], - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where" - }, - { - "schema": {}, - "in": "query", - "name": "nested", - "description": "Query params for nested data" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "count": { - "type": "number", - "x-stoplight": { - "id": "hwq29x70rcipi" - } - } - } - }, - "examples": { - "Example 1": { - "value": { - "count": 25 - } - } - } - } - } - } - } - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/views/{viewName}/{rowId}": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "type": "string", - "example": "vw_75neroyqdye94k" - }, - "name": "viewName", - "in": "path", - "required": true, - "description": "View Name" - }, - { - "schema": { - "example": "1" - }, - "name": "rowId", - "in": "path", - "required": true, - "description": "Unique Row ID" - } - ], - "get": { - "summary": "Get Table View Row", - "operationId": "db-view-row-read", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {} - }, - "examples": { - "Example 1": { - "value": { - "Id": 1, - "Title": "foo", - "CreatedAt": "2023-03-11T09:11:47.437Z", - "UpdatedAt": "2023-03-11T09:11:47.784Z" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Get the target Table View Row", - "tags": ["DB View Row"], - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "patch": { - "summary": "Update Table View Row", - "operationId": "db-view-row-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "examples": { - "Example 1": { - "value": { - "Id": 1, - "Title": "bar", - "CreatedAt": "2023-03-11T09:11:47.437Z", - "UpdatedAt": "2023-03-11T09:20:21.133Z" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View Row"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "examples": { - "Example 1": { - "value": { - "Title": "bar" - } - } - } - } - } - }, - "description": "Update the target Table View Row", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "delete": { - "summary": "Delete Table View Row", - "operationId": "db-view-row-delete", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number" - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View Row"], - "description": "Delete the target Table View Row", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/views/{viewName}/{rowId}/exist": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "type": "string" - }, - "name": "viewName", - "in": "path", - "required": true - }, - { - "schema": { - "example": "1" - }, - "name": "rowId", - "in": "path", - "required": true, - "description": "Unique Row ID" - } - ], - "get": { - "summary": "Does Table View Row Exist", - "operationId": "db-view-row-exist", - "responses": { - "201": { - "description": "Created", - "content": { - "application/json": { - "schema": { - "type": "number" - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Check row with provided primary key exists or not", - "tags": ["DB View Row"], - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/{rowId}": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "example": "1" - }, - "name": "rowId", - "in": "path", - "required": true, - "description": "Unique Row ID" - } - ], - "get": { - "summary": "Get Table Row", - "operationId": "db-table-row-read", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {} - }, - "examples": { - "Example 1": { - "value": { - "Id": 1, - "Title": "foo", - "CreatedAt": "2023-03-11T09:11:47.437Z", - "UpdatedAt": "2023-03-11T09:11:47.784Z" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Get the Table Row by Row ID", - "tags": ["DB Table Row"], - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "patch": { - "summary": "Update Table Row", - "operationId": "db-table-row-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "examples": { - "Example 1": { - "value": { - "Id": 1, - "Title": "bar", - "CreatedAt": "2023-03-11T09:11:47.437Z", - "UpdatedAt": "2023-03-11T09:20:21.133Z" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Row"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "examples": { - "Example 1": { - "value": { - "Title": "bar" - } - } - } - } - } - }, - "description": "Update the Table Row", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "delete": { - "summary": "Delete Table Row", - "operationId": "db-table-row-delete", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number" - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Row"], - "description": "Delete the Table Row", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/{rowId}/exist": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "example": "1" - }, - "name": "rowId", - "in": "path", - "required": true, - "description": "Unique Row ID" - } - ], - "get": { - "summary": "Does Table Row Exist", - "operationId": "db-table-row-exist", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number" - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "check row with provided primary key exists or not", - "tags": ["DB Table Row"], - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/data/bulk/{orgs}/{projectName}/{tableName}": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - } - ], - "post": { - "summary": "Bulk Insert Table Rows", - "operationId": "db-table-row-bulk-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "description": "List of returned IDs", - "items": { - "x-stoplight": { - "id": "dbkhyd3mnajax" - }, - "type": "object", - "properties": { - "id": { - "type": "string", - "x-stoplight": { - "id": "lnwqjl14f287f" - } - } - } - } - }, - "examples": { - "Example 1": { - "value": [ - { - "id": 1 - }, - { - "id": 2 - } - ] - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Row"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "array", - "description": "List of data objects", - "items": { - "x-stoplight": { - "id": "7u0mp8nzlvysz" - }, - "type": "object" - } - }, - "examples": { - "Example 1": { - "value": [ - { - "Title": "abc" - }, - { - "Title": "def" - } - ] - } - } - } - }, - "description": "" - }, - "description": "Bulk insert table rows in one go.", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "patch": { - "summary": "Bulk Update Table Rows by IDs", - "operationId": "db-table-row-bulk-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "description": "List of returned values. 1 means successful. 0 means failed.", - "items": { - "x-stoplight": { - "id": "ga0xhsahovdt7" - }, - "type": "number" - } - }, - "examples": { - "Example 1": { - "value": [1, 1] - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Row"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "array", - "description": "List of data objects", - "items": { - "x-stoplight": { - "id": "q2xtbf29i1s5n" - }, - "type": "object" - } - }, - "examples": { - "Example 1": { - "value": [ - { - "Id": "1", - "Title": "123" - }, - { - "Id": "2", - "Title": "456" - } - ] - } - } - } - } - }, - "description": "Bulk Update Table Rows by given IDs", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "delete": { - "summary": "Bulk Delete Table Rows by IDs", - "operationId": "db-table-row-bulk-delete", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "x-stoplight": { - "id": "b9o9o2r6ipho9" - }, - "type": "number" - } - }, - "examples": { - "Example 1": { - "value": [1, 1] - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Row"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "x-stoplight": { - "id": "sd8udhhjnqiay" - }, - "type": "object" - } - }, - "examples": { - "Example 1": { - "value": [ - { - "Id": "1" - }, - { - "Id": "2" - } - ] - } - } - } - }, - "description": "" - }, - "description": "Bulk Delete Table Rows by given IDs", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/data/bulk/{orgs}/{projectName}/{tableName}/all": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where" - } - ], - "patch": { - "summary": "Bulk Update Table Rows with Conditions", - "operationId": "db-table-row-bulk-update-all", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": {}, - "examples": { - "Example 1": { - "value": [ - { - "Id": "1" - }, - { - "Id": "2" - } - ] - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Row"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "examples": { - "Example 1": { - "value": { - "Title": "foo" - } - } - } - } - } - }, - "description": "Bulk Update all Table Rows if the condition is true", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "delete": { - "summary": "Bulk Delete Table Rows with Conditions", - "operationId": "db-table-row-bulk-delete-all", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "x-stoplight": { - "id": "9gcl3ok7is3y0" - }, - "type": "object" - } - }, - "examples": { - "Example 1": { - "value": [1, 1] - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Row"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "examples": { - "Example 1": { - "value": { - "Title": "foo" - } - } - } - } - } - }, - "description": "Bulk Delete all Table Rows if the condition is true", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/views/{viewName}/export/{type}": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "type": "string" - }, - "name": "viewName", - "in": "path", - "required": true - }, - { - "schema": { - "type": "string", - "enum": ["csv", "excel"] - }, - "name": "type", - "in": "path", - "required": true - } - ], - "get": { - "summary": "Export Table View Rows", - "operationId": "db-view-row-export", - "description": "Export Table View Rows by CSV or Excel", - "tags": ["DB View Row"], - "wrapped": true, - "responses": { - "200": { - "description": "OK", - "content": { - "application/octet-stream": { - "schema": {} - } - }, - "headers": { - "nc-export-offset": { - "schema": { - "type": "integer" - }, - "description": "The starting offset of the next set of rows" - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/export/{type}": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "type": "string", - "enum": ["csv", "excel"] - }, - "name": "type", - "in": "path", - "required": true - } - ], - "get": { - "summary": "Export Table View Rows", - "operationId": "db-table-row-csv-export", - "description": "Export Table View Rows by CSV or Excel", - "tags": ["DB Table Row"], - "wrapped": true, - "responses": { - "200": { - "description": "OK", - "content": { - "application/octet-stream": { - "schema": {} - } - }, - "headers": { - "nc-export-offset": { - "schema": { - "type": "integer" - }, - "description": "The starting offset of the next set of rows" - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/{rowId}/{relationType}/{columnName}": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "example": "1" - }, - "name": "rowId", - "in": "path", - "required": true, - "description": "Unique Row ID" - }, - { - "schema": { - "type": "string", - "enum": ["mm", "hm", "bt"] - }, - "name": "relationType", - "in": "path", - "required": true, - "description": "Relation Type" - }, - { - "schema": { - "type": "string" - }, - "name": "columnName", - "in": "path", - "required": true, - "description": "Column Name" - } - ], - "get": { - "summary": "List Nested Relations Rows", - "operationId": "db-table-row-nested-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": {} - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Row"], - "parameters": [ - { - "schema": { - "type": "integer", - "minimum": 1 - }, - "in": "query", - "name": "limit" - }, - { - "schema": { - "type": "integer", - "minimum": 0 - }, - "in": "query", - "name": "offset" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "description": "List all nested relations rows" - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/{rowId}/{relationType}/{columnName}/{refRowId}": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "example": "1" - }, - "name": "rowId", - "in": "path", - "required": true, - "description": "Unique Row ID" - }, - { - "schema": { - "type": "string", - "enum": ["mm", "hm", "bt"] - }, - "name": "relationType", - "in": "path", - "required": true - }, - { - "schema": { - "type": "string" - }, - "name": "columnName", - "in": "path", - "required": true - }, - { - "schema": { - "type": "string" - }, - "name": "refRowId", - "in": "path", - "required": true - } - ], - "post": { - "summary": "Create Nested Relations Row", - "operationId": "db-table-row-nested-add", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "m6jox00hxgd6s" - }, - "example": "The relation data has been created successfully" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "The relation data has been created successfully" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Row"], - "parameters": [ - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "fields", - "description": "Which fields to be shown" - }, - { - "schema": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "type": "string" - } - ] - }, - "in": "query", - "name": "sort", - "description": "The result will be sorted based on `sort` query" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where", - "description": "Extra filtering" - }, - { - "schema": { - "type": "integer", - "minimum": 0 - }, - "in": "query", - "name": "offset", - "description": "Offset in rows" - }, - { - "schema": { - "type": "integer", - "minimum": 1 - }, - "in": "query", - "name": "limit", - "description": "Limit in rows" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "sortArrJson", - "description": "Used for multiple sort queries" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "filterArrJson", - "description": "Used for multiple filter queries" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "description": "Create a new nested relations row" - }, - "delete": { - "summary": "Delete Nested Relations Row", - "operationId": "db-table-row-nested-remove", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "vo3x8xf3j2xlb" - }, - "example": "The relation data has been deleted successfully" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "The relation data has been deleted successfully" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Row"], - "description": "Delete a new nested relations row", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/{rowId}/{relationType}/{columnName}/exclude": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "example": "1" - }, - "name": "rowId", - "in": "path", - "required": true, - "description": "Unique Row ID" - }, - { - "schema": { - "type": "string", - "enum": ["mm", "hm", "bt"] - }, - "name": "relationType", - "in": "path", - "required": true - }, - { - "schema": { - "type": "string" - }, - "name": "columnName", - "in": "path", - "required": true - } - ], - "get": { - "summary": "Referenced Table Rows Excluding Current Record's Children / Parent", - "operationId": "db-table-row-nested-children-excluded-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": {} - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Row"], - "parameters": [ - { - "schema": { - "type": "integer", - "minimum": 1 - }, - "in": "query", - "name": "limit" - }, - { - "schema": { - "type": "integer", - "minimum": 0 - }, - "in": "query", - "name": "offset" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "description": "Get the table rows but exculding the current record's children and parent" - } - }, - "/api/v1/db/public/shared-view/{sharedViewUuid}/group/{columnId}": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "24a6d0bb-e45d-4b1a-bfef-f492d870de9f" - }, - "name": "sharedViewUuid", - "in": "path", - "required": true, - "description": "Shared View UUID" - }, - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "cl_8iw2o4ejzvdyna", - "type": "string" - }, - "name": "columnId", - "in": "path", - "required": true, - "description": "Unique Column ID" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "xc-password", - "description": "Shared view password" - } - ], - "get": { - "summary": "List Shared View Grouped Data", - "operationId": "public-grouped-data-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "x-stoplight": { - "id": "bldcv1pwuri5s" - }, - "type": "object", - "properties": { - "key": { - "type": "string", - "x-stoplight": { - "id": "n0ujmkbyhgsxo" - }, - "description": "The Grouped Key" - }, - "value": { - "type": "object", - "x-stoplight": { - "id": "0xsi3jvwn7duo" - }, - "description": "the paginated result of the given key", - "required": ["list", "pageInfo"], - "properties": { - "list": { - "type": "array", - "x-stoplight": { - "id": "jw8dmo16txbjv" - }, - "description": "List of the target data", - "items": { - "x-stoplight": { - "id": "xcu8vxmf5ygyi" - }, - "type": "object" - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated", - "x-stoplight": { - "id": "1gsbgwi9bg8s5" - }, - "description": "Paginated Info" - } - } - } - }, - "required": ["key", "value"] - } - }, - "examples": { - "Example 1": { - "value": [ - { - "key": "a", - "value": { - "list": [ - { - "Id": 2, - "Title": "foo", - "s": "a" - } - ], - "pageInfo": { - "totalRows": 1, - "page": 1, - "pageSize": 25, - "isFirstPage": true, - "isLastPage": true - } - } - }, - { - "key": "b", - "value": { - "list": [ - { - "Id": 3, - "Title": "bar", - "s": "b" - } - ], - "pageInfo": { - "totalRows": 1, - "page": 1, - "pageSize": 25, - "isFirstPage": true, - "isLastPage": true - } - } - }, - { - "key": null, - "value": { - "list": [ - { - "Id": 1, - "Title": "baz", - "s": null - } - ], - "pageInfo": { - "totalRows": 1, - "page": 1, - "pageSize": 25, - "isFirstPage": true, - "isLastPage": true - } - } - } - ] - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Public"], - "parameters": [ - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "fields", - "description": "Which fields to be shown" - }, - { - "schema": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "type": "string" - } - ] - }, - "in": "query", - "name": "sort", - "description": "The result will be sorted based on `sort` query" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where", - "description": "Extra filtering" - }, - { - "schema": { - "type": "integer", - "minimum": 0 - }, - "in": "query", - "name": "offset", - "description": "Offset in rows" - }, - { - "schema": { - "type": "integer", - "minimum": 1 - }, - "in": "query", - "name": "limit", - "description": "Limit in rows" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "sortArrJson", - "description": "Used for multiple sort queries" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "filterArrJson", - "description": "Used for multiple filter queries" - } - ], - "description": "List Shared View Grouped Data" - } - }, - "/api/v1/db/public/shared-view/{sharedViewUuid}/rows": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "24a6d0bb-e45d-4b1a-bfef-f492d870de9f" - }, - "name": "sharedViewUuid", - "in": "path", - "required": true, - "description": "Shared View UUID" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "xc-password", - "description": "Shared view password" - } - ], - "get": { - "summary": "List Shared View Rows", - "operationId": "public-data-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SharedViewList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:46:31", - "fk_model_id": "md_mhs9z4r2ak98x0", - "id": "vw_lg052cnc1c26kf", - "is_default": 1, - "lock_type": "collaborative", - "meta": {}, - "order": 1, - "password": null, - "project_id": "p_xm3thidrblw4n7", - "show": 1, - "show_system_fields": null, - "title": "Sheet-1", - "type": 3, - "updated_at": "2023-03-02 17:46:31", - "uuid": null, - "view": { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:46:31", - "fk_view_id": "vw_lg052cnc1c26kf", - "meta": null, - "project_id": "p_xm3thidrblw4n7", - "row_height": null, - "updated_at": "2023-03-02 17:46:31", - "uuid": null - } - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Public"], - "parameters": [ - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "fields", - "description": "Which fields to be shown" - }, - { - "schema": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "type": "string" - } - ] - }, - "in": "query", - "name": "sort", - "description": "The result will be sorted based on `sort` query" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where", - "description": "Extra filtering" - }, - { - "schema": { - "type": "integer", - "minimum": 0 - }, - "in": "query", - "name": "offset", - "description": "Offset in rows" - }, - { - "schema": { - "type": "integer", - "minimum": 1 - }, - "in": "query", - "name": "limit", - "description": "Limit in rows" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "sortArrJson", - "description": "Used for multiple sort queries" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "filterArrJson", - "description": "Used for multiple filter queries" - } - ], - "description": "List all shared view rows" - }, - "post": { - "summary": "Create Share View Row", - "operationId": "public-data-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "examples": { - "Example 1": { - "value": { - "Id": 1, - "col1": "foo", - "col2": "bar", - "CreatedAt": "2023-03-11T08:48:25.598Z", - "UpdatedAt": "2023-03-11T08:48:25.598Z" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "multipart/form-data": {} - }, - "description": "" - }, - "tags": ["Public"], - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "xc-password", - "description": "Shared view password" - } - ], - "description": "Create a new row for the target shared view" - } - }, - "/api/v1/db/public/shared-view/{sharedViewUuid}/rows/{rowId}/{relationType}/{columnName}": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "24a6d0bb-e45d-4b1a-bfef-f492d870de9f" - }, - "name": "sharedViewUuid", - "in": "path", - "required": true, - "description": "Shared View UUID" - }, - { - "schema": { - "example": "1" - }, - "name": "rowId", - "in": "path", - "required": true, - "description": "Unique Row ID" - }, - { - "schema": { - "type": "string", - "enum": ["mm", "hm", "bt"] - }, - "name": "relationType", - "in": "path", - "required": true, - "description": "Relation Type" - }, - { - "schema": { - "type": "string" - }, - "name": "columnName", - "in": "path", - "required": true, - "description": "Column Name" - } - ], - "get": { - "summary": "List Nested List Data", - "operationId": "public-data-nested-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "list": { - "type": "array", - "x-stoplight": { - "id": "gvblksjzjfyg7" - }, - "description": "List of data objects", - "items": { - "x-stoplight": { - "id": "8assgoc1vtcs9" - }, - "type": "object" - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated", - "x-stoplight": { - "id": "if546w1yuo6fw" - }, - "description": "Paginated info" - } - }, - "required": ["list", "pageInfo"] - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "Id": 1, - "Title": "foo", - "CreatedAt": "2023-03-11T08:41:41.356Z", - "UpdatedAt": "2023-03-11T08:41:41.356Z" - }, - { - "Id": 2, - "Title": "bar", - "CreatedAt": "2023-03-11T08:41:45.330Z", - "UpdatedAt": "2023-03-11T08:41:45.330Z" - }, - { - "Id": 3, - "Title": "baz", - "CreatedAt": "2023-03-11T08:48:25.598Z", - "UpdatedAt": "2023-03-11T08:48:25.598Z" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "pageSize": 1, - "sort": "string", - "totalRows": 3 - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Public"], - "parameters": [ - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "fields", - "description": "Which fields to be shown" - }, - { - "schema": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "type": "string" - } - ] - }, - "in": "query", - "name": "sort", - "description": "The result will be sorted based on `sort` query" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where", - "description": "Extra filtering" - }, - { - "schema": { - "type": "integer", - "minimum": 0 - }, - "in": "query", - "name": "offset", - "description": "Offset in rows" - }, - { - "schema": { - "type": "integer", - "minimum": 1 - }, - "in": "query", - "name": "limit", - "description": "Limit in rows" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "sortArrJson", - "description": "Used for multiple sort queries" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "filterArrJson", - "description": "Used for multiple filter queries" - } - ], - "description": "List all nested list data in a given shared view" - } - }, - "/api/v1/db/public/shared-view/{sharedViewUuid}/rows/export/{type}": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "76d44b86-bc65-4500-8956-ab512c80ab25" - }, - "name": "sharedViewUuid", - "in": "path", - "required": true, - "description": "Shared View UUID" - }, - { - "schema": { - "type": "string", - "enum": ["csv", "excel"], - "example": "csv" - }, - "name": "type", - "in": "path", - "required": true, - "description": "Export Type" - } - ], - "get": { - "summary": "Export Rows in Share View", - "operationId": "public-csv-export", - "description": "Export all rows in Share View in a CSV / Excel Format", - "wrapped": true, - "responses": { - "200": { - "description": "OK", - "content": { - "application/octet-stream": { - "schema": {} - } - }, - "headers": { - "nc-export-offset": { - "schema": { - "type": "integer" - }, - "description": "The starting offset of the next set of rows" - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Public"] - } - }, - "/api/v1/db/public/shared-view/{sharedViewUuid}/nested/{columnName}": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "24a6d0bb-e45d-4b1a-bfef-f492d870de9f" - }, - "name": "sharedViewUuid", - "in": "path", - "required": true, - "description": "Shared View UUID" - }, - { - "schema": { - "type": "string" - }, - "name": "columnName", - "in": "path", - "required": true, - "description": "Column Name" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "xc-password", - "description": "Shared view password" - } - ], - "get": { - "summary": "List Nested Data Relation", - "operationId": "public-data-relation-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": {} - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "parameters": [ - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "fields", - "description": "Which fields to be shown" - }, - { - "schema": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "type": "string" - } - ] - }, - "in": "query", - "name": "sort", - "description": "The result will be sorted based on `sort` query" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where", - "description": "Extra filtering" - }, - { - "schema": { - "type": "integer", - "minimum": 0 - }, - "in": "query", - "name": "offset", - "description": "Offset in rows" - }, - { - "schema": { - "type": "integer", - "minimum": 1 - }, - "in": "query", - "name": "limit", - "description": "Limit in rows" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "sortArrJson", - "description": "Used for multiple sort queries" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "filterArrJson", - "description": "Used for multiple filter queries" - } - ], - "tags": ["Public"], - "description": "List Nested Data Relation" - } - }, - "/api/v1/db/public/shared-base/{sharedBaseUuid}/meta": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "24a6d0bb-e45d-4b1a-bfef-f492d870de9f" - }, - "name": "sharedBaseUuid", - "in": "path", - "required": true, - "description": "Shared Base UUID" - } - ], - "get": { - "summary": "Get Share Base Meta", - "operationId": "public-shared-base-get", - "description": "Get Share Base Meta", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "project_id": { - "type": "string", - "description": "Project ID" - } - } - }, - "examples": { - "Example 1": { - "value": { - "project_id": "p_63b4q0qengen1x" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Public"] - } - }, - "/api/v1/db/public/shared-view/{sharedViewUuid}/meta": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "24a6d0bb-e45d-4b1a-bfef-f492d870de9f" - }, - "name": "sharedViewUuid", - "in": "path", - "required": true, - "description": "Shared View UUID" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "xc-password", - "description": "Shared view password" - } - ], - "get": { - "summary": "Get Share View Meta", - "operationId": "public-shared-view-meta-get", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/View" - }, - { - "type": "object", - "properties": { - "relatedMetas": {}, - "client": { - "type": "string" - }, - "base_id": { - "type": "string" - }, - "columns": { - "allOf": [ - { - "anyOf": [ - { - "$ref": "#/components/schemas/GridColumn" - }, - { - "$ref": "#/components/schemas/FormColumn" - }, - { - "$ref": "#/components/schemas/GalleryColumn" - } - ] - }, - { - "$ref": "#/components/schemas/Column" - } - ] - }, - "model": { - "$ref": "#/components/schemas/Table" - } - } - }, - { - "type": "object", - "properties": { - "view": { - "anyOf": [ - { - "$ref": "#/components/schemas/Form" - }, - { - "$ref": "#/components/schemas/Grid" - }, - { - "$ref": "#/components/schemas/Gallery" - } - ] - } - } - } - ] - } - }, - "application/xml": { - "schema": {} - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Public"], - "description": "Get Share View Meta" - } - }, - "/api/v1/db/meta/audits/comments": { - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "get": { - "summary": "List Comments in Audit", - "operationId": "utils-comment-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "list": { - "x-stoplight": { - "id": "5zto1xohsngbu" - }, - "type": "array", - "items": { - "$ref": "#/components/schemas/Audit", - "x-stoplight": { - "id": "d22zkup0c0l80" - } - } - } - }, - "required": ["list"] - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "id": "adt_3sii7erfwrlegb", - "user": "w@nocodb.com", - "ip": null, - "base_id": null, - "project_id": "p_63b4q0qengen1x", - "fk_model_id": "md_5mipbdg6ketmv8", - "row_id": "1", - "op_type": "COMMENT", - "op_sub_type": null, - "status": null, - "description": "bar", - "details": null, - "created_at": "2023-03-13T09:39:14.225Z", - "updated_at": "2023-03-13T09:39:14.225Z" - }, - { - "id": "adt_fezs668qbxj8gc", - "user": "w@nocodb.com", - "ip": null, - "base_id": null, - "project_id": "p_63b4q0qengen1x", - "fk_model_id": "md_5mipbdg6ketmv8", - "row_id": "1", - "op_type": "COMMENT", - "op_sub_type": null, - "status": null, - "description": "foo", - "details": null, - "created_at": "2023-03-13T09:39:13.321Z", - "updated_at": "2023-03-13T09:39:13.321Z" - } - ] - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "List all comments", - "parameters": [ - { - "schema": { - "type": "string", - "example": "10" - }, - "in": "query", - "name": "row_id", - "required": true, - "description": "Row ID" - }, - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "md_c6csq89tl37jm5" - }, - "in": "query", - "name": "fk_model_id", - "required": true, - "description": "Foreign Key to Model" - }, - { - "schema": { - "type": "boolean", - "example": true - }, - "in": "query", - "name": "comments_only", - "description": "Is showing comments only?" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["Utils"] - }, - "post": { - "summary": "Comment Rows", - "operationId": "utils-comment-row", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Audit" - }, - "examples": { - "Example 1": { - "value": { - "user": "w@nocodb.com", - "row_id": "1", - "fk_model_id": "md_5mipbdg6ketmv8", - "op_type": "COMMENT", - "description": "qq", - "project_id": "p_63b4q0qengen1x", - "id": "adt_vx58jpp0loo8qy" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CommentReq" - }, - "examples": { - "Example 1": { - "value": { - "description": "This is the comment for the row", - "fk_model_id": "md_ehn5izr99m7d45", - "row_id": "3" - } - } - } - } - } - }, - "tags": ["Utils"], - "description": "Create a new comment in a row. Logged in Audit.", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/audits/{auditId}/comment": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "adt_zlskd6rlf3liay" - }, - "name": "auditId", - "in": "path", - "required": true, - "description": "Audit ID" - }, - { - "name": "xc-auth", - "in": "header", - "required": false, - "schema": { - "type": "string" - }, - "description": "Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN." - } - ], - "patch": { - "summary": "Update Comment in Audit", - "operationId": "utils-comment-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number", - "example": 1 - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - } - }, - "tags": ["Utils"], - "description": "Update comment in Audit", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CommentUpdateReq" - }, - "examples": { - "Example 1": { - "value": { - "description": "This is the comment for the row" - } - } - } - } - } - } - } - }, - "/api/v1/db/meta/audits/comments/count": { - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "get": { - "summary": "Count Comments", - "operationId": "utils-comment-count", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "x-stoplight": { - "id": "ziwcy4va5r1ao" - }, - "type": "object", - "properties": { - "count": { - "type": "string", - "x-stoplight": { - "id": "5r91gkxmaiyv4" - }, - "description": "The number of comments", - "example": "4" - }, - "row_id": { - "type": "string", - "x-stoplight": { - "id": "08sgorhq172sm" - }, - "description": "Row ID", - "example": "1" - } - }, - "required": ["count", "row_id"] - } - }, - "examples": { - "Example 1": { - "value": [ - { - "count": "4", - "row_id": "1" - } - ] - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Return the number of comments in the given query.", - "parameters": [ - { - "in": "query", - "name": "ids", - "required": true, - "description": "Comment IDs" - }, - { - "schema": { - "$ref": "#/components/schemas/Id" - }, - "in": "query", - "name": "fk_model_id", - "required": true, - "description": "Foreign Key to Model" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["Utils"] - } - }, - "/api/v1/db/meta/projects/{projectId}/audits": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - } - ], - "get": { - "summary": "List Audits in Project", - "operationId": "project-audit-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "list": { - "type": "array", - "uniqueItems": true, - "minItems": 1, - "items": { - "$ref": "#/components/schemas/Audit" - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated" - } - }, - "required": ["list", "pageInfo"] - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "List all audit data in the given project", - "parameters": [ - { - "schema": { - "type": "integer", - "minimum": 0 - }, - "in": "query", - "name": "offset" - }, - { - "schema": { - "type": "integer", - "maximum": 1 - }, - "in": "query", - "name": "limit" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["Project"] - } - }, - "/api/v1/db/meta/audits/rows/{rowId}/update": { - "parameters": [ - { - "schema": { - "example": "1" - }, - "name": "rowId", - "in": "path", - "required": true, - "description": "Unique Row ID" - } - ], - "post": { - "summary": "Update Audit Row", - "operationId": "utils-audit-row-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Audit" - }, - "examples": { - "Example 1": { - "value": { - "user": "w@nocodb.com", - "row_id": "1", - "fk_model_id": "md_5mipbdg6ketmv8", - "op_type": "COMMENT", - "description": "Table Sheet-1 : field Column A got changed from foo to bar", - "project_id": "p_63b4q0qengen1x", - "id": "adt_vx58jpp0loo8qy" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Utils"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AuditRowUpdateReq" - }, - "examples": { - "Example 1": { - "value": { - "column_name": "baz", - "fk_model_id": "md_ehn5izr99m7d45", - "row_id": "1", - "prev_value": "foo", - "value": "bar" - } - } - } - } - } - }, - "description": "Update Audit Row", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/tables/{tableId}/hooks": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "md_w9gpnaousnfss1", - "type": "string" - }, - "name": "tableId", - "in": "path", - "required": true, - "description": "Unique Table ID" - } - ], - "get": { - "summary": "List Table Hooks", - "operationId": "db-table-webhook-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HookList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "active": 0, - "async": 0, - "description": "This is my hook description", - "env": "all", - "event": "after", - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "string", - "notification": "{\"type\":\"URL\",\"payload\":{\"method\":\"POST\",\"body\":\"{{ json data }}\",\"headers\":[{}],\"parameters\":[{}],\"auth\":\"\",\"path\":\"http://example.com\"}}", - "null": null, - "operation": "insert", - "retries": 10, - "retry_interval": 60000, - "timeout": 60000, - "title": "My Webhook" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "List all hook records in the given Table", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["DB Table Webhook"] - }, - "post": { - "summary": "Create Table Hook", - "operationId": "db-table-webhook-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Hook" - }, - "examples": { - "Example 1": { - "value": { - "active": 0, - "async": 0, - "description": "This is my hook description", - "env": "all", - "event": "after", - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "string", - "notification": "{\"type\":\"URL\",\"payload\":{\"method\":\"POST\",\"body\":\"{{ json data }}\",\"headers\":[{}],\"parameters\":[{}],\"auth\":\"\",\"path\":\"http://example.com\"}}", - "null": null, - "operation": "insert", - "retries": 10, - "retry_interval": 60000, - "timeout": 60000, - "title": "My Webhook" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Create a hook in the given table", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HookReq" - }, - "examples": { - "Example 1": { - "value": { - "active": 0, - "async": 0, - "description": "This is my hook description", - "env": "all", - "event": "after", - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "string", - "notification": "{\"type\":\"URL\",\"payload\":{\"method\":\"POST\",\"body\":\"{{ json data }}\",\"headers\":[{}],\"parameters\":[{}],\"auth\":\"\",\"path\":\"http://example.com\"}}", - "null": null, - "operation": "insert", - "retries": 10, - "retry_interval": 60000, - "timeout": 60000, - "title": "My Webhook", - "condition": false - } - } - } - } - } - }, - "tags": ["DB Table Webhook"] - } - }, - "/api/v1/db/meta/tables/{tableId}/hooks/test": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "md_w9gpnaousnfss1", - "type": "string" - }, - "name": "tableId", - "in": "path", - "required": true, - "description": "Unique Table ID" - } - ], - "post": { - "summary": "Test Hook", - "operationId": "db-table-webhook-test", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "l5k90tzuvvv1g" - }, - "example": "The hook has been tested successfully" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "The hook has been tested successfully" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Webhook"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HookTestReq" - }, - "examples": { - "Example 1": { - "value": { - "hook": { - "active": 0, - "async": 0, - "description": "This is my hook description", - "env": "all", - "event": "after", - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "string", - "notification": "{\"type\":\"URL\",\"payload\":{\"method\":\"POST\",\"body\":\"{{ json data }}\",\"headers\":[{}],\"parameters\":[{}],\"auth\":\"\",\"path\":\"http://example.com\"}}", - "null": null, - "operation": "insert", - "retries": 10, - "retry_interval": 60000, - "timeout": 60000, - "title": "My Webhook" - }, - "payload": { - "data": { - "Id": 1, - "Title": "Sample Text", - "CreatedAt": "2023-03-03T10:03:06.484Z", - "UpdatedAt": "2023-03-03T10:03:06.484Z", - "attachment": [ - { - "url": "https://nocodb.com/dummy.png", - "title": "image.png", - "mimetype": "image/png", - "size": 0 - } - ], - "f": "Sample Output" - } - } - } - } - } - } - } - }, - "description": "Test the hook in the given Table", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/tables/{tableId}/hooks/samplePayload/{operation}/{version}": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "md_w9gpnaousnfss1", - "type": "string" - }, - "name": "tableId", - "in": "path", - "required": true, - "description": "Unique Table ID" - }, - { - "schema": { - "type": "string", - "enum": [ - "insert", - "update", - "delete", - "bulkInsert", - "bulkUpdate", - "bulkDelete" - ] - }, - "name": "operation", - "in": "path", - "required": true, - "description": "Hook Operation" - }, - { - "schema": { - "type": "string", - "enum": ["v1", "v2"] - }, - "name": "version", - "in": "path", - "required": true, - "description": "Hook Version" - } - ], - "get": { - "summary": "Get Sample Hook Payload", - "operationId": "db-table-webhook-sample-payload-get", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "data": { - "type": "object", - "x-stoplight": { - "id": "qifsikf69hqbl" - }, - "description": "Sample Payload Data" - } - } - }, - "examples": { - "Example 1": { - "value": { - "data": { - "Id": 1, - "Title": "Sample Text", - "CreatedAt": "2023-03-13T04:59:49.363Z", - "UpdatedAt": "2023-03-13T04:59:49.363Z" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Get the sample hook payload", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["DB Table Webhook"] - } - }, - "/api/v1/db/meta/hooks/{hookId}": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "hk_0063k4o1frnxbr" - }, - "name": "hookId", - "in": "path", - "required": true, - "description": "Unique Hook ID" - } - ], - "patch": { - "summary": "Update Hook", - "operationId": "db-table-webhook-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Hook" - }, - "examples": { - "Example 1": { - "value": { - "active": 0, - "async": 0, - "description": "This is my hook description", - "env": "all", - "event": "after", - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "string", - "notification": "{\"type\":\"URL\",\"payload\":{\"method\":\"POST\",\"body\":\"{{ json data }}\",\"headers\":[{}],\"parameters\":[{}],\"auth\":\"\",\"path\":\"http://example.com\"}}", - "null": null, - "operation": "insert", - "retries": 10, - "retry_interval": 60000, - "timeout": 60000, - "title": "My Webhook" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Webhook"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Hook" - }, - "examples": { - "Example 1": { - "value": { - "active": 0, - "async": 0, - "description": "This is my hook description", - "env": "all", - "event": "after", - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "string", - "notification": "{\"type\":\"URL\",\"payload\":{\"method\":\"POST\",\"body\":\"{{ json data }}\",\"headers\":[{}],\"parameters\":[{}],\"auth\":\"\",\"path\":\"http://example.com\"}}", - "null": null, - "operation": "insert", - "retries": 10, - "retry_interval": 60000, - "timeout": 60000, - "title": "My Webhook" - } - } - } - } - } - }, - "description": "Update the exsiting hook by its ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "delete": { - "summary": "Delete Hook", - "operationId": "db-table-webhook-delete", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "boolean" - }, - "examples": { - "Example 1": { - "value": true - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Webhook"], - "description": "Delete the exsiting hook by its ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/plugins": { - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "get": { - "summary": "List Plugins", - "operationId": "plugin-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "list": { - "type": "array", - "uniqueItems": true, - "minItems": 1, - "items": { - "$ref": "#/components/schemas/Plugin" - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "List all plugins", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["Plugin"] - } - }, - "/api/v1/db/meta/plugins/{pluginTitle}/status": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "pluginTitle", - "in": "path", - "required": true, - "description": "Plugin Title" - } - ], - "get": { - "summary": "Get Plugin Status", - "operationId": "plugin-status", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "boolean" - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Check plugin is active or not", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["Plugin"], - "x-internal": false - } - }, - "/api/v1/db/meta/plugins/test": { - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "post": { - "summary": "Test Plugin", - "operationId": "plugin-test", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": {} - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Test if the plugin is working with the given configurations", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["Plugin"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PluginTestReq" - }, - "examples": { - "Example 1": { - "value": { - "title": "Plugin Foo", - "input": "{\"bucket\":\"my-bucket\",\"region\":\"us-west-004\",\"access_key\":\"redacted\",\"access_secret\":\"redacted\"}", - "category": "Email" - } - } - } - } - } - } - } - }, - "/api/v1/db/meta/plugins/{pluginId}": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "pluginId", - "in": "path", - "required": true, - "description": "Plugin ID" - } - ], - "patch": { - "summary": "Update Plugin", - "operationId": "plugin-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": {} - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Plugin"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PluginReq" - } - } - } - }, - "description": "Update the plugin data by ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "x-internal": false - }, - "get": { - "summary": "Get Plugin", - "operationId": "plugin-read", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Plugin" - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Plugin"], - "description": "Get the plugin data by ID", - "x-internal": false - } - }, - "/api/v1/db/meta/connection/test": { - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "post": { - "summary": "Test DB Connection", - "operationId": "utils-test-connection", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "code": { - "type": "number" - }, - "message": { - "type": "string" - }, - "data": { - "type": "object", - "x-stoplight": { - "id": "6orbk04w97ien" - } - } - } - }, - "examples": { - "Example 1": { - "value": { - "code": 0, - "message": "", - "data": {} - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Utils"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "x-examples": { - "Example 1": { - "client": "mysql2", - "connection": { - "host": "localhost", - "port": "3306", - "user": "root", - "password": "password", - "database": null - } - } - }, - "properties": { - "client": { - "description": "DB Type", - "enum": [ - "mssql", - "mysql", - "mysql2", - "oracledb", - "pg", - "snowflake", - "sqlite3" - ], - "example": "mysql2", - "type": "string" - }, - "connection": { - "type": "object", - "properties": { - "host": { - "type": "string" - }, - "port": { - "type": "string" - }, - "user": { - "type": "string" - }, - "password": { - "type": "string" - }, - "database": { - "$ref": "#/components/schemas/StringOrNull" - } - } - } - } - }, - "examples": { - "Example 1": { - "value": { - "client": "mysql2", - "connection": { - "host": "localhost", - "port": "3306", - "user": "root", - "password": "password", - "database": null - } - } - } - } - } - } - }, - "description": "Test the DB Connection", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/url_to_config": { - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "post": { - "summary": "Convert JDBC URL to Config", - "operationId": "utils-url-to-config", - "tags": ["Utils"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "url": { - "type": "string", - "x-stoplight": { - "id": "fgdbmcjjtkky5" - }, - "description": "JDBC URL", - "example": "jdbc:mysql://username:password@localhost:3306/sakila" - } - } - }, - "examples": { - "Example 1": { - "value": { - "url": "jdbc:mysql://username:password@localhost:3306/sakila" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "x-examples": { - "Example 1": { - "client": "mysql2", - "connection": { - "user": "username", - "password": "password", - "database": "sakila", - "host": "localhost", - "port": "3306" - } - } - }, - "properties": { - "client": { - "description": "DB Type", - "enum": [ - "mssql", - "mysql", - "mysql2", - "oracledb", - "pg", - "snowflake", - "sqlite3" - ], - "example": "mysql2", - "type": "string" - }, - "connection": { - "type": "object", - "description": "Connection Config", - "properties": { - "user": { - "type": "string", - "description": "DB User" - }, - "password": { - "type": "string", - "description": "DB Password" - }, - "database": { - "type": "string", - "description": "DB Name" - }, - "host": { - "type": "string", - "description": "DB Host" - }, - "port": { - "type": "string", - "description": "DB Host" - } - } - } - } - }, - "examples": { - "Example 1": { - "value": { - "client": "mysql2", - "connection": { - "user": "username", - "password": "password", - "database": "sakila", - "host": "localhost", - "port": "3306" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Extract XC URL From JDBC and parse to connection config", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/nocodb/info": { - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "get": { - "summary": "Get App Info", - "operationId": "utils-app-info", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "x-examples": { - "Example 1": { - "authType": "jwt", - "projectHasAdmin": true, - "firstUser": false, - "type": "rest", - "googleAuthEnabled": false, - "githubAuthEnabled": false, - "oneClick": false, - "connectToExternalDB": true, - "version": "0.105.3", - "defaultLimit": 25, - "ncMin": false, - "teleEnabled": false, - "auditEnabled": true, - "ncSiteUrl": "http://localhost:8080", - "ee": false, - "ncAttachmentFieldSize": 20971520, - "ncMaxAttachmentsAllowed": 10 - } - }, - "properties": { - "authType": { - "type": "string" - }, - "projectHasAdmin": { - "type": "boolean" - }, - "firstUser": { - "type": "boolean" - }, - "type": { - "type": "string" - }, - "googleAuthEnabled": { - "type": "boolean" - }, - "githubAuthEnabled": { - "type": "boolean" - }, - "oneClick": { - "type": "boolean" - }, - "connectToExternalDB": { - "type": "boolean" - }, - "version": { - "type": "string" - }, - "defaultLimit": { - "type": "number" - }, - "ncMin": { - "type": "boolean" - }, - "teleEnabled": { - "type": "boolean" - }, - "auditEnabled": { - "type": "boolean" - }, - "ncSiteUrl": { - "type": "string" - }, - "ee": { - "type": "boolean" - }, - "ncAttachmentFieldSize": { - "type": "number" - }, - "ncMaxAttachmentsAllowed": { - "type": "number" - }, - "isCloud": { - "type": "boolean", - "x-stoplight": { - "id": "bstdkpky2131f" - } - }, - "automationLogLevel": { - "type": "string", - "x-stoplight": { - "id": "uc3vaotye2eu8" - }, - "enum": ["OFF", "ERROR", "ALL"], - "example": "OFF" - } - } - }, - "examples": { - "Example 1": { - "value": { - "authType": "jwt", - "projectHasAdmin": true, - "firstUser": false, - "type": "rest", - "googleAuthEnabled": false, - "githubAuthEnabled": false, - "oneClick": false, - "connectToExternalDB": true, - "version": "0.105.3", - "defaultLimit": 25, - "ncMin": false, - "teleEnabled": false, - "auditEnabled": true, - "ncSiteUrl": "http://localhost:8080", - "ee": false, - "ncAttachmentFieldSize": 20971520, - "ncMaxAttachmentsAllowed": 10, - "isCloud": false, - "automationLogLevel": "OFF" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Utils"], - "description": "Get the application info such as authType, defaultLimit, version and etc.", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/axiosRequestMake": { - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "post": { - "summary": "Axios Request", - "operationId": "utils-axios-request-make", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {} - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Generic Axios Call", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object" - } - } - } - }, - "tags": ["Utils"], - "x-internal": true, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/version": { - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "get": { - "summary": "Get App Version", - "operationId": "utils-app-version", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "x-examples": { - "Example 1": { - "currentVersion": "0.105.3", - "releaseVersion": "0.105.3" - } - }, - "properties": { - "currentVersion": { - "type": "string", - "description": "Current NocoDB Version", - "example": "0.104.0" - }, - "releaseVersion": { - "type": "string", - "description": "Latest Release Version", - "example": "0.105.3" - } - } - }, - "examples": { - "Example 1": { - "value": { - "currentVersion": "0.104.0", - "releaseVersion": "0.105.3" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Utils"], - "description": "Get the application version", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/health": { - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "get": { - "summary": "Get Application Health Status", - "operationId": "utils-app-health", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "x-examples": { - "Example 1": { - "message": "OK", - "timestamp": 1678702175755, - "uptime": 1618.996877834 - } - }, - "properties": { - "message": { - "type": "string", - "example": "OK" - }, - "timestamp": { - "type": "string", - "example": "1678702175755" - }, - "uptime": { - "type": "string", - "example": "1618.996877834" - } - } - }, - "examples": { - "Example 1": { - "value": { - "message": "OK", - "timestamp": 1678702175755, - "uptime": 1618.996877834 - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Utils"], - "description": "Get Application Health Status", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/aggregated-meta-info": { - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "get": { - "summary": "Get Aggregated Meta Info", - "operationId": "utils-aggregated-meta-info", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "projectCount": { - "type": "integer" - }, - "projects": { - "type": "array", - "items": { - "type": "object", - "properties": { - "tableCount": { - "type": "object", - "properties": { - "table": { - "type": "integer", - "description": "Table Count" - }, - "view": { - "type": "integer", - "description": "View Count" - } - } - }, - "external": { - "type": "boolean", - "description": "External Project", - "default": false - }, - "viewCount": { - "type": "object", - "properties": { - "formCount": { - "type": "integer", - "description": "Form Count" - }, - "gridCount": { - "type": "integer", - "description": "Grid Count" - }, - "galleryCount": { - "type": "integer", - "description": "Gallery Count" - }, - "kanbanCount": { - "type": "integer", - "description": "Kanban Count" - }, - "total": { - "type": "integer", - "description": "Total View Count" - }, - "sharedFormCount": { - "type": "integer", - "description": "Shared Form Count" - }, - "sharedGridCount": { - "type": "integer", - "description": "Shared Grid Count" - }, - "sharedGalleryCount": { - "type": "integer", - "description": "Shared Gallery Count" - }, - "sharedKanbanCount": { - "type": "integer", - "description": "Shared Kanban Count" - }, - "sharedTotal": { - "type": "integer", - "description": "Shared Total View Count" - }, - "sharedLockedCount": { - "type": "integer", - "description": "Shared Locked View Count" - } - } - }, - "webhookCount": { - "type": "integer", - "description": "Webhook Count" - }, - "filterCount": { - "type": "integer", - "description": "Filter Count" - }, - "sortCount": { - "type": "integer", - "description": "Sort Count" - }, - "rowCount": { - "type": "array", - "items": { - "type": "object", - "properties": { - "TotalRecords": { - "type": "string" - } - } - }, - "description": "Row Count" - }, - "userCount": { - "type": "integer", - "description": "Total project user Count" - } - } - } - }, - "userCount": { - "type": "integer", - "description": "Total user Count" - }, - "sharedBaseCount": { - "type": "integer", - "description": "Total shared base Count" - } - }, - "x-examples": { - "Example 1": { - "projectCount": 1, - "projects": [ - { - "tableCount": { - "table": 3, - "view": 0 - }, - "external": false, - "viewCount": { - "formCount": 0, - "gridCount": 3, - "galleryCount": 0, - "kanbanCount": 0, - "total": 3, - "sharedFormCount": 0, - "sharedGridCount": 0, - "sharedGalleryCount": 0, - "sharedKanbanCount": 0, - "sharedTotal": 0, - "sharedLockedCount": 0 - }, - "webhookCount": 0, - "filterCount": 0, - "sortCount": 0, - "rowCount": [ - { - "TotalRecords": "76" - } - ], - "userCount": 1 - } - ], - "userCount": 1, - "sharedBaseCount": 0 - } - } - }, - "examples": { - "example-1": { - "value": { - "projectCount": 1, - "projects": [ - { - "tableCount": { - "table": 3, - "view": 0 - }, - "external": false, - "viewCount": { - "formCount": 0, - "gridCount": 3, - "galleryCount": 0, - "kanbanCount": 0, - "total": 3, - "sharedFormCount": 0, - "sharedGridCount": 0, - "sharedGalleryCount": 0, - "sharedKanbanCount": 0, - "sharedTotal": 0, - "sharedLockedCount": 0 - }, - "webhookCount": 0, - "filterCount": 0, - "sortCount": 0, - "rowCount": [ - { - "TotalRecords": "76" - } - ], - "userCount": 1 - } - ], - "userCount": 1, - "sharedBaseCount": 0 - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Utils"], - "description": "Get Aggregated Meta Info such as tableCount, dbViewCount, viewCount and etc.", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/cache": { - "get": { - "summary": "Get Cache", - "tags": ["Utils"], - "responses": {}, - "operationId": "utils-cache-get", - "description": "Get All K/V pairs in NocoCache", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "delete": { - "summary": "Delete Cache", - "operationId": "utils-cache-delete", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "boolean" - }, - "examples": { - "Example 1": { - "value": true - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Delete All K/V pairs in NocoCache", - "tags": ["Utils"], - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "/api/v1/db/meta/projects/{projectId}/api-tokens": { - "get": { - "summary": "List API Tokens in Project", - "tags": ["API Token"], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiTokenList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "id": "1", - "fk_user_id": "us_b3xo2i44nx5y9l", - "description": "This API Token is for ABC application", - "token": "DYh540o8hbWpUGdarekECKLdN5OhlgCUWutVJYX2" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "operationId": "api-token-list", - "description": "List API Tokens in the given project", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "post": { - "summary": "Create API Token", - "operationId": "api-token-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiToken" - }, - "examples": { - "Example 1": { - "value": { - "id": "1", - "fk_user_id": "us_b3xo2i44nx5y9l", - "description": "This API Token is for ABC application", - "token": "DYh540o8hbWpUGdarekECKLdN5OhlgCUWutVJYX2" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiTokenReq" - }, - "examples": { - "Example 1": { - "value": { - "description": "This API token is for ABC application" - } - } - } - } - }, - "description": "" - }, - "tags": ["API Token"], - "description": "Create API Token in a project", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - } - ] - }, - "/api/v1/db/meta/projects/{projectId}/api-tokens/{token}": { - "delete": { - "summary": "Delete API Token", - "operationId": "api-token-delete", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number", - "example": 1 - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["API Token"], - "description": "Delete the given API Token in project", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - }, - { - "schema": { - "type": "string", - "example": "DYh540o8hbWpUGdarekECKLdN5OhlgCUWutVJYX2" - }, - "name": "token", - "in": "path", - "required": true, - "description": "API Token" - } - ] - }, - "/api/v1/db/storage/upload": { - "post": { - "summary": "Attachment Upload", - "operationId": "storage-upload", - "responses": {}, - "tags": ["Storage"], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "$ref": "#/components/schemas/AttachmentReq" - }, - "examples": { - "Example 1": { - "value": { - "mimetype": "image/jpeg", - "path": "download/noco/jango_fett/Table1/attachment/uVbjPVQxC_SSfs8Ctx.jpg", - "size": 13052, - "title": "22bc-kavypmq4869759 (1).jpg" - } - } - } - } - }, - "description": "" - }, - "parameters": [ - { - "schema": { - "type": "string", - "example": "download/noco/jango_fett/Table1/attachment/uVbjPVQxC_SSfs8Ctx.jpg" - }, - "name": "path", - "in": "query", - "required": true, - "description": "Target File Path" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "description": "Upload attachment" - } - }, - "/api/v1/db/storage/upload-by-url": { - "post": { - "summary": "Attachment Upload by URL", - "operationId": "storage-upload-by-url", - "responses": {}, - "tags": ["Storage"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AttachmentReq" - } - }, - "examples": {} - } - } - }, - "parameters": [ - { - "schema": { - "type": "string", - "example": "download/noco/jango_fett/Table1/attachment/c7z_UF8sZBgJUxMjpN.jpg" - }, - "name": "path", - "in": "query", - "description": "Target File Path", - "required": true - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "description": "Upload attachment by URL. Used in Airtable Migration." - } - }, - "/api/v1/db/meta/projects/{projectId}/users/{userId}/resend-invite": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - }, - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "us_b3xo2i44nx5y9l" - }, - "name": "userId", - "in": "path", - "required": true, - "description": "Unique User ID" - } - ], - "post": { - "summary": "Resend User Invitation", - "operationId": "auth-project-user-resend-invite", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "m570oh5j3afjt" - }, - "description": "Success Message", - "example": "The invitation has been sent to the user" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "The invitation has been sent to the user" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Auth"], - "description": "Resend Invitation to a specific user", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - } - }, - "components": { - "schemas": { - "ApiToken": { - "description": "Model for API Token", - "examples": [ - { - "id": "1", - "fk_user_id": "us_b3xo2i44nx5y9l", - "description": "This API Token is for ABC application", - "token": "DYh540o8hbWpUGdarekECKLdN5OhlgCUWutVJYX2" - } - ], - "title": "API Token Model", - "type": "object", - "properties": { - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique API Token ID" - }, - "fk_user_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to User" - }, - "description": { - "type": "string", - "description": "API Token Description", - "example": "This API Token is for ABC application" - }, - "token": { - "type": "string", - "description": "API Token", - "example": "DYh540o8hbWpUGdarekECKLdN5OhlgCUWutVJYX2" - } - }, - "x-stoplight": { - "id": "95rfb0httdmw0" - } - }, - "ApiTokenReq": { - "description": "Model for API Token Request", - "examples": [ - { - "description": "This API token is for ABC application" - } - ], - "title": "API Token Request Model", - "type": "object", - "properties": { - "description": { - "description": "Description of the API token", - "maxLength": 255, - "type": "string", - "example": "This API Token is for ABC application" - } - }, - "x-stoplight": { - "id": "h3g2houpa6y9y" - } - }, - "ApiTokenList": { - "description": "Model for API Token List", - "x-stoplight": { - "id": "35b7cvjplxmfm" - }, - "examples": [ - { - "list": [ - { - "id": "1", - "fk_user_id": "us_b3xo2i44nx5y9l", - "description": "This API Token is for ABC application", - "token": "DYh540o8hbWpUGdarekECKLdN5OhlgCUWutVJYX2" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - ], - "title": "API Token List Model", - "type": "object", - "properties": { - "list": { - "type": "array", - "example": [ - { - "list": [ - { - "id": "1", - "fk_user_id": "us_b3xo2i44nx5y9l", - "description": "This API Token is for ABC application", - "token": "DYh540o8hbWpUGdarekECKLdN5OhlgCUWutVJYX2" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - ], - "x-stoplight": { - "id": "c7xu43yjgyjww" - }, - "description": "List of api token objects", - "items": { - "$ref": "#/components/schemas/ApiToken", - "x-stoplight": { - "id": "5ih4l0ix2tr5q" - } - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated", - "x-stoplight": { - "id": "0w8ktfnx3pusz" - }, - "description": "Model for Paginated" - } - }, - "required": ["list", "pageInfo"] - }, - "Attachment": { - "description": "Model for Attachment", - "examples": [ - { - "data": null, - "mimetype": "image/jpeg", - "path": "download/noco/jango_fett/Table1/attachment/c7z_UF8sZBgJUxMjpN.jpg", - "size": 12345, - "title": "kavypmq4869759.jpg" - } - ], - "title": "Attachment Model", - "type": "object", - "properties": { - "data": { - "description": "Data for uploading" - }, - "mimetype": { - "type": "string", - "description": "The mimetype of the attachment" - }, - "path": { - "type": "string", - "description": "File Path" - }, - "size": { - "type": "number", - "description": "Attachment Size" - }, - "title": { - "type": "string", - "description": "The title of the attachment. Used in UI." - }, - "url": { - "type": "string", - "description": "Attachment URL" - } - }, - "x-stoplight": { - "id": "pbx8hqgwdz7lw" - } - }, - "AttachmentReq": { - "description": "Model for Attachment Request", - "type": "object", - "x-examples": { - "Example 1": { - "mimetype": "image/jpeg", - "path": "download/noco/jango_fett/Table1/attachment/uVbjPVQxC_SSfs8Ctx.jpg", - "size": 13052, - "title": "22bc-kavypmq4869759 (1).jpg" - } - }, - "title": "Attachment Request Model", - "properties": { - "mimetype": { - "type": "string", - "description": "The mimetype of the attachment" - }, - "path": { - "type": "string", - "description": "The file path of the attachment" - }, - "size": { - "type": "number", - "description": "The size of the attachment" - }, - "title": { - "type": "string", - "description": "The title of the attachment used in UI" - }, - "url": { - "type": "string", - "description": "Attachment URL to be uploaded via upload-by-url" - } - }, - "x-stoplight": { - "id": "jmahtr8c5rw7f" - } - }, - "Audit": { - "description": "Model for Audit", - "examples": [ - { - "id": "adt_l5we7pkx70vaao", - "user": "w@nocodb.com", - "ip": "::ffff:127.0.0.1", - "base_id": "ds_3l9qx8xqksenrl", - "project_id": "p_9sx43moxhqtjm3", - "fk_model_id": "md_ehn5izr99m7d45", - "row_id": "rec0Adp9PMG9o7uJy", - "op_type": "AUTHENTICATION", - "op_sub_type": "UPDATE", - "status": "string", - "description": "Table nc_snms___Table_1 : field Date got changed from 2023-03-12 to ", - "details": "Date : 2023-03-12 " - } - ], - "title": "Audit Model", - "type": "object", - "properties": { - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "user": { - "type": "string", - "description": "The user name performing the action", - "example": "w@nocodb.com" - }, - "ip": { - "type": "string", - "example": "::ffff:127.0.0.1", - "description": "IP address from the user" - }, - "base_id": { - "type": "string", - "description": "Base ID in where action is performed", - "example": "ds_3l9qx8xqksenrl" - }, - "project_id": { - "type": "string", - "description": "Project ID in where action is performed", - "example": "p_9sx43moxhqtjm3" - }, - "fk_model_id": { - "type": "string", - "description": "Model ID in where action is performed", - "example": "md_ehn5izr99m7d45" - }, - "row_id": { - "type": "string", - "description": "Row ID", - "example": "rec0Adp9PMG9o7uJy" - }, - "op_type": { - "type": "string", - "description": "Operation Type", - "example": "AUTHENTICATION", - "enum": [ - "COMMENT", - "DATA", - "PROJECT", - "VIRTUAL_RELATION", - "RELATION", - "TABLE_VIEW", - "TABLE", - "VIEW", - "META", - "WEBHOOKS", - "AUTHENTICATION", - "TABLE_COLUMN", - "ORG_USER" - ] - }, - "op_sub_type": { - "type": "string", - "description": "Operation Sub Type", - "example": "UPDATE", - "enum": [ - "UPDATE", - "INSERT", - "BULK_INSERT", - "BULK_UPDATE", - "BULK_DELETE", - "LINK_RECORD", - "UNLINK_RECORD", - "DELETE", - "CREATE", - "RENAME", - "IMPORT_FROM_ZIP", - "EXPORT_TO_FS", - "EXPORT_TO_ZIP", - "SIGNIN", - "SIGNUP", - "PASSWORD_RESET", - "PASSWORD_FORGOT", - "PASSWORD_CHANGE", - "EMAIL_VERIFICATION", - "ROLES_MANAGEMENT", - "INVITE", - "RESEND_INVITE" - ] - }, - "status": { - "type": "string", - "description": "Audit Status" - }, - "description": { - "type": "string", - "description": "Description of the action", - "example": "Table nc_snms___Table_1 : field Date got changed from 2023-03-12 to " - }, - "details": { - "type": "string", - "description": "Detail", - "example": "Date : 2023-03-12 " - } - }, - "x-stoplight": { - "id": "i5ug0n7j1wub8" - } - }, - "AuditRowUpdateReq": { - "description": "Model for Audit Row Update Request", - "examples": [ - { - "column_name": "baz", - "fk_model_id": "md_ehn5izr99m7d45", - "row_id": "rec0Adp9PMG9o7uJy", - "prev_value": "foo", - "value": "bar" - } - ], - "title": "Audit Row Update Request Model", - "type": "object", - "properties": { - "column_name": { - "type": "string", - "description": "Column Name", - "example": "baz" - }, - "fk_model_id": { - "type": "string", - "description": "Foreign Key to Model", - "example": "md_ehn5izr99m7d45" - }, - "row_id": { - "type": "string", - "example": "rec0Adp9PMG9o7uJy", - "description": "Row ID" - }, - "prev_value": { - "description": "The previous value before the action" - }, - "value": { - "description": "The current value after the action" - } - }, - "x-stoplight": { - "id": "jcw57b1yv3xog" - } - }, - "Base": { - "description": "Model for Base", - "examples": [ - { - "alias": null, - "config": "", - "enabled": 1, - "id": "ds_krsappzu9f8vmo", - "inflection_column": "camelize", - "inflection_table": "camelize", - "is_meta": 1, - "meta": null, - "order": 1, - "project_id": "p_01clqvzik3izk6", - "type": "mysql2" - } - ], - "title": "Base Model", - "type": "object", - "properties": { - "alias": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Base Name - Default BASE will be null by default" - }, - "config": { - "description": "Base Configuration" - }, - "enabled": { - "$ref": "#/components/schemas/Bool", - "description": "Is this base enabled" - }, - "id": { - "description": "Unique Base ID", - "type": "string" - }, - "inflection_column": { - "description": "Inflection for columns", - "example": "camelize", - "type": "string" - }, - "inflection_table": { - "description": "Inflection for tables", - "example": "camelize", - "type": "string" - }, - "is_meta": { - "$ref": "#/components/schemas/Bool", - "description": "Is the data source connected externally" - }, - "order": { - "description": "The order of the list of bases", - "example": 1, - "type": "number" - }, - "project_id": { - "description": "The project ID that this base belongs to", - "type": "string" - }, - "type": { - "description": "DB Type", - "enum": [ - "mssql", - "mysql", - "mysql2", - "oracledb", - "pg", - "snowflake", - "sqlite3" - ], - "example": "mysql2", - "type": "string" - } - }, - "x-stoplight": { - "id": "9hy3cgp0r2c95" - } - }, - "BaseList": { - "description": "Model for Base List", - "examples": [ - { - "list": [ - { - "alias": null, - "config": "", - "enabled": 1, - "id": "ds_krsappzu9f8vmo", - "inflection_column": "camelize", - "inflection_table": "camelize", - "is_meta": 1, - "meta": null, - "order": 1, - "project_id": "p_01clqvzik3izk6", - "type": "mysql2" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - ], - "title": "Base List Model", - "type": "object", - "x-examples": { - "example-1": { - "bases": { - "list": [ - { - "alias": "sakila", - "config": "", - "created_at": "2023-03-02 11:28:17", - "enabled": 1, - "id": "ds_btbdt19zde0gj9", - "inflection_column": "camelize", - "inflection_table": "camelize", - "is_meta": null, - "meta": null, - "order": 2, - "project_id": "p_01clqvzik3izk6", - "type": "mysql2", - "updated_at": "2023-03-02 11:28:17" - }, - { - "alias": null, - "config": "", - "created_at": "2023-03-01 16:31:49", - "enabled": 1, - "id": "ds_krsappzu9f8vmo", - "inflection_column": "camelize", - "inflection_table": "camelize", - "is_meta": 1, - "meta": null, - "order": 1, - "project_id": "p_01clqvzik3izk6", - "type": "mysql2", - "updated_at": "2023-03-02 11:28:17" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 2, - "totalRows": 2 - } - } - } - }, - "properties": { - "list": { - "type": "array", - "x-stoplight": { - "id": "1q3ny60j1g4z2" - }, - "description": "List of base objects", - "items": { - "$ref": "#/components/schemas/Base", - "x-stoplight": { - "id": "udd0nrcv6pq8d" - } - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated", - "x-stoplight": { - "id": "xqwcniocq37hk" - }, - "description": "Paginated Info" - } - }, - "required": ["list", "pageInfo"], - "x-stoplight": { - "id": "kk8uqxeefumma" - } - }, - "BaseReq": { - "description": "Model for Base Request", - "examples": [ - { - "alias": "My Base", - "config": null, - "inflection_column": "camelize", - "inflection_table": "camelize", - "is_meta": true, - "type": "mysql" - } - ], - "properties": { - "alias": { - "description": "Base Name - Default BASE will be null by default", - "example": "My Base", - "maxLength": 128, - "type": "string" - }, - "config": { - "description": "Base Configuration" - }, - "inflection_column": { - "description": "Inflection for columns", - "example": "camelize", - "type": "string" - }, - "inflection_table": { - "description": "Inflection for tables", - "example": "camelize", - "type": "string" - }, - "is_meta": { - "description": "Is the data source connected externally", - "type": "boolean" - }, - "type": { - "description": "DB Type", - "enum": [ - "mssql", - "mysql", - "mysql2", - "oracledb", - "pg", - "snowflake", - "sqlite3" - ], - "type": "string" - } - }, - "title": "Base Request", - "type": "object", - "x-stoplight": { - "id": "j2z6ain3204zi" - } - }, - "Bool": { - "description": "Model for Bool", - "examples": [true], - "oneOf": [ - { - "description": "0 or 1", - "example": 0, - "type": "integer" - }, - { - "description": "true or false", - "type": "boolean" - }, - { - "type": "null" - } - ], - "title": "Bool Model", - "x-stoplight": { - "id": "8n3vnyr22sbvj" - } - }, - "Column": { - "description": "Model for Column", - "examples": [ - { - "ai": 0, - "au": 0, - "base_id": "ds_krsappzu9f8vmo", - "cc": "", - "cdf": null, - "clen": "45", - "column_name": "title", - "cop": "2", - "created_at": "2023-03-02 13:14:16", - "csn": "utf8mb4", - "ct": "varchar(45)", - "deleted": null, - "dt": "varchar", - "dtx": "specificType", - "dtxp": "45", - "dtxs": null, - "fk_model_id": "md_yvwvbt2i78rgcm", - "id": "cl_0j9gv0oi8vjy46", - "meta": null, - "np": null, - "ns": null, - "order": 2, - "pk": 0, - "project_id": "p_01clqvzik3izk6", - "pv": 1, - "rqd": 0, - "system": 0, - "title": "Title", - "uidt": "SingleLineText", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 13:14:16", - "validate": null, - "virtual": null - } - ], - "title": "Column Model", - "type": "object", - "properties": { - "ai": { - "$ref": "#/components/schemas/Bool", - "description": "Is Auto-Increment?" - }, - "au": { - "$ref": "#/components/schemas/Bool", - "description": "Auto Update Timestamp" - }, - "base_id": { - "description": "Base ID that this column belongs to", - "example": "ds_krsappzu9f8vmo", - "type": "string" - }, - "cc": { - "description": "Column Comment", - "type": "string" - }, - "cdf": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Column Default" - }, - "clen": { - "description": "Character Maximum Length", - "oneOf": [ - { - "type": "integer" - }, - { - "type": "null" - }, - { - "type": "string" - } - ] - }, - "colOptions": { - "anyOf": [ - { - "$ref": "#/components/schemas/Formula" - }, - { - "$ref": "#/components/schemas/LinkToAnotherRecord" - }, - { - "$ref": "#/components/schemas/Lookup" - }, - { - "$ref": "#/components/schemas/Rollup" - }, - { - "$ref": "#/components/schemas/SelectOptions" - }, - { - "type": "object" - } - ], - "description": "Column Options" - }, - "column_name": { - "description": "Column Name", - "example": "title", - "type": "string" - }, - "cop": { - "description": "Column Ordinal Position", - "type": "string" - }, - "csn": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Character Set Name" - }, - "ct": { - "description": "Column Type", - "example": "varchar(45)", - "type": "string" - }, - "deleted": { - "$ref": "#/components/schemas/Bool", - "description": "Is Deleted?" - }, - "dt": { - "description": "Data Type in DB", - "example": "varchar", - "type": "string" - }, - "dtx": { - "description": "Data Type X", - "example": "specificType", - "type": "string" - }, - "dtxp": { - "description": "Data Type X Precision", - "oneOf": [ - { - "type": "null" - }, - { - "type": "number" - }, - { - "type": "string" - } - ] - }, - "dtxs": { - "description": "Data Type X Scale", - "oneOf": [ - { - "type": "null" - }, - { - "type": "number" - }, - { - "type": "string" - } - ] - }, - "fk_model_id": { - "description": "Model ID that this column belongs to", - "example": "md_yvwvbt2i78rgcm", - "type": "string" - }, - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "description": "Meta Info" - }, - "np": { - "description": "Numeric Precision", - "oneOf": [ - { - "type": "integer" - }, - { - "type": "null" - }, - { - "type": "string" - } - ] - }, - "ns": { - "description": "Numeric Scale", - "oneOf": [ - { - "type": "integer" - }, - { - "type": "null" - }, - { - "type": "string" - } - ] - }, - "order": { - "description": "The order of the list of columns", - "type": "number" - }, - "pk": { - "$ref": "#/components/schemas/Bool", - "description": "Is Primary Key?" - }, - "pv": { - "$ref": "#/components/schemas/Bool", - "description": "Is Primary Value?" - }, - "rqd": { - "$ref": "#/components/schemas/Bool", - "description": "Is Required?" - }, - "system": { - "$ref": "#/components/schemas/Bool", - "description": "Is System Column?" - }, - "title": { - "description": "Column Title", - "example": "Title", - "type": "string" - }, - "uidt": { - "description": "The data type in UI", - "example": "SingleLineText", - "enum": [ - "Attachment", - "AutoNumber", - "Barcode", - "Button", - "Checkbox", - "Collaborator", - "Count", - "CreateTime", - "Currency", - "Date", - "DateTime", - "Decimal", - "Duration", - "Email", - "Formula", - "ForeignKey", - "GeoData", - "Geometry", - "ID", - "JSON", - "LastModifiedTime", - "LongText", - "LinkToAnotherRecord", - "Lookup", - "MultiSelect", - "Number", - "Percent", - "PhoneNumber", - "Rating", - "Rollup", - "SingleLineText", - "SingleSelect", - "SpecificDBType", - "Time", - "URL", - "Year", - "QrCode" - ], - "type": "string" - }, - "un": { - "$ref": "#/components/schemas/Bool", - "description": "Is Unsigned?" - }, - "unique": { - "$ref": "#/components/schemas/Bool", - "description": "Is unique?" - }, - "visible": { - "$ref": "#/components/schemas/Bool", - "description": "Is Visible?" - } - }, - "x-stoplight": { - "id": "3a4lsn477mx4e" - } - }, - "ColumnList": { - "description": "Model for Column List", - "examples": [ - { - "list": [ - { - "ai": 0, - "au": 0, - "base_id": "ds_krsappzu9f8vmo", - "cc": "", - "cdf": null, - "clen": "45", - "column_name": "title", - "cop": "2", - "created_at": "2023-03-02 13:14:16", - "csn": "utf8mb4", - "ct": "varchar(45)", - "deleted": null, - "dt": "varchar", - "dtx": "specificType", - "dtxp": "45", - "dtxs": null, - "fk_model_id": "md_yvwvbt2i78rgcm", - "id": "cl_0j9gv0oi8vjy46", - "meta": null, - "np": null, - "ns": null, - "order": 2, - "pk": 0, - "project_id": "p_01clqvzik3izk6", - "pv": 1, - "rqd": 0, - "system": 0, - "title": "Title", - "uidt": "SingleLineText", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 13:14:16", - "validate": null, - "virtual": null - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - ], - "title": "Column List Model", - "type": "object", - "x-examples": { - "example-1": { - "bases": { - "list": [ - { - "alias": "string", - "database": "string", - "host": "string", - "id": "string", - "params": "string", - "password": "string", - "port": 0, - "project_id": "string", - "ssl": "string", - "type": "string", - "url": "string", - "username": "string" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "pageSize": 0, - "sort": "string", - "totalRows": 0 - } - } - } - }, - "properties": { - "list": { - "type": "array", - "x-stoplight": { - "id": "c6lpw8px25356" - }, - "description": "List of column objects", - "items": { - "$ref": "#/components/schemas/Column", - "x-stoplight": { - "id": "zbm89i86dr73y" - } - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated", - "x-stoplight": { - "id": "ko0s0z13h4hsw" - } - } - }, - "required": ["list", "pageInfo"], - "x-stoplight": { - "id": "rldg44w1alasg" - } - }, - "ColumnReq": { - "allOf": [ - { - "anyOf": [ - { - "$ref": "#/components/schemas/FormulaColumnReq" - }, - { - "$ref": "#/components/schemas/LinkToAnotherColumnReq" - }, - { - "$ref": "#/components/schemas/LookupColumnReq" - }, - { - "$ref": "#/components/schemas/NormalColumnRequest" - }, - { - "$ref": "#/components/schemas/RollupColumnReq" - } - ] - }, - { - "properties": { - "column_name": { - "type": "string" - }, - "column_order": { - "description": "Column order in a specific view", - "properties": { - "order": { - "type": "number" - }, - "view_id": { - "type": "string" - } - }, - "type": "object" - }, - "title": { - "maxLength": 255, - "minLength": 1, - "type": "string" - } - }, - "required": ["title"] - } - ], - "description": "Model for Column Request", - "examples": [ - { - "ai": 0, - "au": 0, - "base_id": "ds_krsappzu9f8vmo", - "cc": "", - "cdf": null, - "clen": "45", - "column_name": "title", - "cop": "2", - "created_at": "2023-03-02 13:14:16", - "csn": "utf8mb4", - "ct": "varchar(45)", - "deleted": null, - "dt": "varchar", - "dtx": "specificType", - "dtxp": "45", - "dtxs": null, - "fk_model_id": "md_yvwvbt2i78rgcm", - "id": "cl_0j9gv0oi8vjy46", - "meta": null, - "np": null, - "ns": null, - "order": 2, - "pk": 0, - "project_id": "p_01clqvzik3izk6", - "pv": 1, - "rqd": 0, - "system": 0, - "title": "Title", - "uidt": "SingleLineText", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 13:14:16", - "validate": null, - "virtual": null - } - ], - "title": "Column Request Model", - "type": "object", - "x-stoplight": { - "id": "dvbn9dnme6jgi" - } - }, - "CommentReq": { - "description": "Model for Comment Request", - "examples": [ - { - "description": "This is the comment for the row", - "fk_model_id": "md_ehn5izr99m7d45", - "row_id": "3" - } - ], - "title": "Comment Request Model", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Description for the target row", - "example": "This is the comment for the row" - }, - "fk_model_id": { - "type": "string", - "description": "Foreign Key to Model", - "example": "md_ehn5izr99m7d45" - }, - "row_id": { - "type": "string", - "description": "Row ID", - "example": "3" - } - }, - "required": ["fk_model_id", "row_id"], - "x-stoplight": { - "id": "7nwlyinuliuvy" - } - }, - "CommentUpdateReq": { - "description": "Model for Comment Update Request", - "x-stoplight": { - "id": "r0f3ng2rahe38" - }, - "examples": [ - { - "description": "This is the comment for the row" - } - ], - "title": "Comment Update Request Model", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Description for the target row", - "example": "This is the comment for the row" - } - } - }, - "Filter": { - "description": "Model for Filter", - "examples": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "comparison_op": "eq", - "comparison_sub_op": null, - "created_at": "2023-03-02 18:18:05", - "fk_column_id": "cl_d7ah9n2qfupgys", - "fk_hook_id": null, - "fk_parent_id": null, - "fk_view_id": "vw_b739e29vqmrxnf", - "id": "fi_xn647tpmdq8fu8", - "is_group": null, - "logical_op": "and", - "order": 1, - "project_id": "p_xm3thidrblw4n7", - "updated_at": "2023-03-02 18:18:05", - "value": "foo" - } - ], - "properties": { - "base_id": { - "description": "Unqiue Base ID", - "readOnly": true, - "type": "string" - }, - "children": { - "description": "Children filters. Available when the filter is grouped.", - "items": { - "$ref": "#/components/schemas/Filter" - }, - "type": "array" - }, - "comparison_op": { - "description": "Comparison Operator", - "enum": [ - "allof", - "anyof", - "blank", - "btw", - "checked", - "empty", - "eq", - "ge", - "gt", - "gte", - "in", - "is", - "isWithin", - "isnot", - "le", - "like", - "lt", - "lte", - "nallof", - "nanyof", - "nbtw", - "neq", - "nlike", - "not", - "notblank", - "notchecked", - "notempty", - "notnull", - "null" - ], - "type": "string" - }, - "comparison_sub_op": { - "anyOf": [ - { - "enum": [ - "daysAgo", - "daysFromNow", - "exactDate", - "nextMonth", - "nextNumberOfDays", - "nextWeek", - "nextYear", - "oneMonthAgo", - "oneMonthFromNow", - "oneWeekAgo", - "oneWeekFromNow", - "pastMonth", - "pastNumberOfDays", - "pastWeek", - "pastYear", - "today", - "tomorrow", - "yesterday" - ], - "type": "string" - }, - { - "type": "null" - } - ], - "description": "Comparison Sub-Operator" - }, - "fk_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Column" - }, - "fk_hook_id": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Foreign Key to Hook" - }, - "fk_model_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Model" - }, - "fk_parent_id": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Foreign Key to parent group." - }, - "fk_view_id": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Foreign Key to View" - }, - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "is_group": { - "description": "Is this filter grouped?", - "oneOf": [ - { - "type": "boolean" - }, - { - "type": "integer" - }, - { - "type": "null" - } - ] - }, - "logical_op": { - "description": "Logical Operator", - "enum": ["and", "not", "or"], - "type": "string" - }, - "project_id": { - "description": "Unique Project ID", - "readOnly": true, - "type": "string" - }, - "value": { - "description": "The filter value. Can be NULL for some operators." - } - }, - "readOnly": true, - "title": "Filter Model", - "type": "object", - "x-stoplight": { - "id": "f8vsb8alix01i" - } - }, - "FilterList": { - "description": "Model for Filter List", - "examples": [ - { - "list": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "comparison_op": "eq", - "comparison_sub_op": null, - "created_at": "2023-03-02 18:18:05", - "fk_column_id": "cl_d7ah9n2qfupgys", - "fk_hook_id": null, - "fk_parent_id": null, - "fk_view_id": "vw_b739e29vqmrxnf", - "id": "fi_xn647tpmdq8fu8", - "is_group": null, - "logical_op": "and", - "order": 1, - "project_id": "p_xm3thidrblw4n7", - "updated_at": "2023-03-02 18:18:05", - "value": "foo" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - ], - "title": "Filter List Model", - "type": "object", - "x-examples": { - "example-1": { - "bases": { - "list": [ - { - "alias": "string", - "database": "string", - "host": "string", - "id": "string", - "params": "string", - "password": "string", - "port": 0, - "project_id": "string", - "ssl": "string", - "type": "string", - "url": "string", - "username": "string" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "pageSize": 0, - "sort": "string", - "totalRows": 0 - } - } - } - }, - "properties": { - "list": { - "type": "array", - "x-stoplight": { - "id": "22sgv37ve9kxo" - }, - "description": "List of filter objects", - "items": { - "$ref": "#/components/schemas/Filter", - "x-stoplight": { - "id": "ttw5rxhy83k8p" - } - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated", - "x-stoplight": { - "id": "7cyrb1770mrzz" - } - } - }, - "required": ["list", "pageInfo"], - "x-stoplight": { - "id": "mfxg43iomcoue" - } - }, - "FilterLogList": { - "description": "Model for Filter Log List", - "x-stoplight": { - "id": "0voe9zdizy5qd" - }, - "examples": [ - { - "list": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "comparison_op": "eq", - "comparison_sub_op": null, - "created_at": "2023-03-02 18:18:05", - "fk_column_id": "cl_d7ah9n2qfupgys", - "fk_hook_id": null, - "fk_parent_id": null, - "fk_view_id": "vw_b739e29vqmrxnf", - "id": "fi_xn647tpmdq8fu8", - "is_group": null, - "logical_op": "and", - "order": 1, - "project_id": "p_xm3thidrblw4n7", - "updated_at": "2023-03-02 18:18:05", - "value": "foo" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - ], - "title": "Filter Log List Model", - "type": "object", - "x-examples": { - "example-1": { - "bases": { - "list": [ - { - "alias": "string", - "database": "string", - "host": "string", - "id": "string", - "params": "string", - "password": "string", - "port": 0, - "project_id": "string", - "ssl": "string", - "type": "string", - "url": "string", - "username": "string" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "pageSize": 0, - "sort": "string", - "totalRows": 0 - } - } - } - }, - "properties": { - "list": { - "type": "array", - "x-stoplight": { - "id": "22sgv37ve9kxo" - }, - "description": "List of filter objects", - "items": { - "$ref": "#/components/schemas/Filter", - "x-stoplight": { - "id": "ttw5rxhy83k8p" - } - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated", - "x-stoplight": { - "id": "7cyrb1770mrzz" - } - } - }, - "required": ["list", "pageInfo"] - }, - "FilterReq": { - "description": "Model for Filter Request", - "examples": [ - { - "comparison_op": "eq", - "comparison_sub_op": null, - "fk_column_id": "cl_d7ah9n2qfupgys", - "is_group": false, - "logical_op": "and", - "value": "foo" - } - ], - "title": "Filter Request Model", - "type": "object", - "x-stoplight": { - "id": "pugjn1hobswqf" - }, - "properties": { - "comparison_op": { - "description": "Comparison Operator", - "enum": [ - "allof", - "anyof", - "blank", - "btw", - "checked", - "empty", - "eq", - "ge", - "gt", - "gte", - "in", - "is", - "isWithin", - "isnot", - "le", - "like", - "lt", - "lte", - "nallof", - "nanyof", - "nbtw", - "neq", - "nlike", - "not", - "notblank", - "notchecked", - "notempty", - "notnull", - "null" - ], - "type": "string" - }, - "comparison_sub_op": { - "anyOf": [ - { - "enum": [ - "daysAgo", - "daysFromNow", - "exactDate", - "nextMonth", - "nextNumberOfDays", - "nextWeek", - "nextYear", - "oneMonthAgo", - "oneMonthFromNow", - "oneWeekAgo", - "oneWeekFromNow", - "pastMonth", - "pastNumberOfDays", - "pastWeek", - "pastYear", - "today", - "tomorrow", - "yesterday" - ], - "type": "string" - }, - { - "type": "null" - } - ], - "description": "Comparison Sub-Operator" - }, - "fk_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Column" - }, - "fk_parent_id": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Belong to which filter ID" - }, - "is_group": { - "$ref": "#/components/schemas/Bool", - "description": "Is this filter grouped?" - }, - "logical_op": { - "description": "Logical Operator", - "enum": ["and", "not", "or"], - "type": "string" - }, - "value": { - "description": "The filter value. Can be NULL for some operators." - } - }, - "readOnly": true - }, - "Form": { - "description": "Model for Form", - "examples": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "banner_image_url": null, - "columns": [ - { - "id": "fvc_ugj9zo5bzocxtl", - "base_id": "ds_g4ccx6e77h1dmi", - "project_id": "p_xm3thidrblw4n7", - "fk_view_id": "vw_kdf5cr7qmhksek", - "fk_column_id": "cl_phvuuwjrzcdo0g", - "uuid": null, - "label": null, - "help": null, - "description": null, - "required": null, - "show": 0, - "order": 1, - "created_at": "2023-03-04 16:40:47", - "updated_at": "2023-03-04 16:40:47", - "meta": {} - } - ], - "email": "user@example.com", - "fk_model_id": "md_rsu68aqjsbyqtl", - "heading": "My Form", - "lock_type": "collaborative", - "logo_url": null, - "meta": null, - "redirect_after_secs": null, - "redirect_url": null, - "show_blank_form": 0, - "subheading": "My Form Subheading", - "submit_another_form": 0, - "success_msg": "Thank you for the submission.", - "title": "Form View 1" - } - ], - "title": "Form Model", - "type": "object", - "properties": { - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID", - "x-stoplight": { - "id": "z6wjvs00d3qfk" - } - }, - "banner_image_url": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Banner Image URL. Not in use currently." - }, - "columns": { - "type": "array", - "description": "Form Columns", - "items": { - "$ref": "#/components/schemas/FormColumn" - } - }, - "email": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Email to sned after form is submitted" - }, - "fk_model_id": { - "type": "string", - "description": "Foreign Key to Model", - "example": "md_rsu68aqjsbyqtl" - }, - "base_id": { - "type": "string", - "description": "Base ID", - "example": "md_rsu68aqjsbyqtl", - "x-stoplight": { - "id": "kfz7tve8nzj6f" - } - }, - "heading": { - "type": "string", - "description": "The heading of the form", - "example": "My Form" - }, - "lock_type": { - "enum": ["collaborative", "locked", "personal"], - "type": "string", - "description": "Lock Type of this view", - "example": "collaborative" - }, - "logo_url": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Logo URL. Not in use currently." - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "description": "Meta Info for this view" - }, - "redirect_after_secs": { - "$ref": "#/components/schemas/StringOrNull", - "description": "The numbers of seconds to redirect after form submission" - }, - "redirect_url": { - "$ref": "#/components/schemas/StringOrNull", - "description": "URL to redirect after submission" - }, - "show_blank_form": { - "$ref": "#/components/schemas/Bool", - "description": "Show `Blank Form` after 5 seconds" - }, - "subheading": { - "type": "string", - "description": "The subheading of the form", - "example": "My Form Subheading" - }, - "submit_another_form": { - "$ref": "#/components/schemas/Bool", - "description": "Show `Submit Another Form` button" - }, - "success_msg": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Custom message after the form is successfully submitted" - }, - "title": { - "type": "string", - "description": "Form View Title", - "example": "Form View 1" - } - }, - "x-stoplight": { - "id": "918aga51qb7w1" - } - }, - "FormUpdateReq": { - "description": "Model for Form Update Request", - "examples": [ - { - "banner_image_url": null, - "email": "user@example.com", - "heading": "My Form", - "logo_url": null, - "meta": null, - "redirect_after_secs": null, - "redirect_url": null, - "show_blank_form": 0, - "subheading": "My Form Subheading", - "submit_another_form": 0, - "success_msg": "Thank you for the submission." - } - ], - "title": "Form Update Request Model", - "type": "object", - "properties": { - "banner_image_url": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Banner Image URL. Not in use currently." - }, - "email": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Email to sned after form is submitted" - }, - "heading": { - "description": "The heading of the form", - "example": "My Form", - "maxLength": 255, - "type": "string" - }, - "logo_url": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Logo URL. Not in use currently." - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "description": "Meta Info for this view" - }, - "redirect_after_secs": { - "$ref": "#/components/schemas/StringOrNull", - "description": "The numbers of seconds to redirect after form submission" - }, - "redirect_url": { - "$ref": "#/components/schemas/StringOrNull", - "description": "URL to redirect after submission" - }, - "show_blank_form": { - "$ref": "#/components/schemas/Bool", - "description": "Show `Blank Form` after 5 seconds" - }, - "subheading": { - "$ref": "#/components/schemas/StringOrNull", - "description": "The subheading of the form" - }, - "submit_another_form": { - "$ref": "#/components/schemas/Bool", - "description": "Show `Submit Another Form` button" - }, - "success_msg": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Custom message after the form is successfully submitted" - } - }, - "x-stoplight": { - "id": "zn4juts75pksq" - } - }, - "FormColumn": { - "description": "Model for Form Column", - "examples": [ - { - "id": "fvc_1m9b0aub791d4m", - "description": null, - "fk_column_id": "cl_ah9zavkn25ihyd", - "fk_view_id": "vw_6fqln9vdytdv8q", - "help": "This is a help text", - "label": "Form Label", - "meta": null, - "order": 1, - "required": 0, - "show": 0, - "uuid": null - } - ], - "title": "Form Column Model", - "type": "object", - "x-examples": { - "example-1": { - "_cn": "first_name", - "alias": "first_name", - "created_at": "2022-02-15 12:39:04", - "description": "dsdsdsdsd", - "fk_column_id": "cl_yvyhsl9u81tokc", - "fk_view_id": "vw_s1pf4umdnikoyn", - "help": null, - "id": "fvc_8z1i7t8aswkqxx", - "label": "dsdsds", - "order": 1, - "required": false, - "show": 1, - "enable_scanner": true, - "updated_at": "2022-02-15 12:39:16", - "uuid": null - } - }, - "properties": { - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "description": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Form Column Description (Not in use)" - }, - "fk_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Column" - }, - "fk_view_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to View" - }, - "help": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Form Column Help Text" - }, - "label": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Form Column Label" - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "description": "Meta Info" - }, - "order": { - "type": "number", - "description": "The order among all the columns in the form", - "example": 1 - }, - "required": { - "$ref": "#/components/schemas/Bool", - "description": "Is this form column required in submission?" - }, - "show": { - "$ref": "#/components/schemas/Bool", - "description": "Is this column shown in Form?" - }, - "enable_scanner": { - "$ref": "#/components/schemas/Bool", - "description": "Indicates whether the 'Fill by scan' button is visible for this column or not.", - "example": true - }, - "uuid": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Form Column UUID (Not in use)" - } - }, - "x-stoplight": { - "id": "gm46pinkspvrz" - } - }, - "FormColumnReq": { - "description": "Model for Form Column Request", - "examples": [ - { - "description": null, - "help": "This is a help text", - "label": "Form Label", - "meta": null, - "order": 1, - "required": 0, - "show": 0 - } - ], - "title": "Form Column Request Model", - "type": "object", - "x-examples": { - "example-1": { - "_cn": "first_name", - "alias": "first_name", - "created_at": "2022-02-15 12:39:04", - "description": "dsdsdsdsd", - "fk_column_id": "cl_yvyhsl9u81tokc", - "fk_view_id": "vw_s1pf4umdnikoyn", - "help": null, - "id": "fvc_8z1i7t8aswkqxx", - "label": "dsdsds", - "order": 1, - "required": false, - "show": 1, - "updated_at": "2022-02-15 12:39:16", - "uuid": null - } - }, - "properties": { - "description": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Form Column Description (Not in use)" - }, - "help": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Form Column Help Text" - }, - "label": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Form Column Label" - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "description": "Meta Info" - }, - "order": { - "type": "number", - "description": "The order among all the columns in the form" - }, - "required": { - "$ref": "#/components/schemas/Bool", - "description": "Is this form column required in submission?" - }, - "show": { - "$ref": "#/components/schemas/Bool", - "description": "Is this column shown in Form?" - } - }, - "x-stoplight": { - "id": "nmffmb1p3wkg9" - } - }, - "Formula": { - "description": "Model for Formula", - "examples": [ - { - "id": "fm_1lo8wqtvvipdns", - "fk_column_id": "cl_h2micb4jdnmsh1", - "formula": "CONCAT(\"FOO\", {{cl_c5knoi4xs4sfpt}})", - "formula_raw": "CONCAT(\"FOO\", {Title})", - "error": "Error Message shows here" - } - ], - "title": "Formula Model", - "type": "object", - "properties": { - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "fk_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Column" - }, - "formula": { - "type": "string", - "description": "Formula with column ID replaced", - "example": "CONCAT(\"FOO\", {{cl_c5knoi4xs4sfpt}})" - }, - "formula_raw": { - "type": "string", - "description": "Original Formula inputted in UI", - "example": "CONCAT(\"FOO\", {Title})" - }, - "error": { - "type": "string", - "description": "Error Message" - } - }, - "x-stoplight": { - "id": "hlu7yokpavxwb" - } - }, - "FormulaColumnReq": { - "description": "Model for Formula Column Request", - "examples": [ - { - "formula": "CONCAT(\"FOO\", {{cl_c5knoi4xs4sfpt}})", - "formula_raw": "CONCAT(\"FOO\", {Title})", - "title": "Formula", - "uidt": "Formula" - } - ], - "title": "Formula Column Request Model", - "type": "object", - "properties": { - "formula": { - "type": "string", - "description": "Formula with column ID replaced" - }, - "formula_raw": { - "type": "string", - "description": "Original Formula inputted in UI" - }, - "title": { - "maxLength": 255, - "minLength": 1, - "type": "string", - "description": "Formula Title" - }, - "uidt": { - "enum": ["Formula"], - "type": "string", - "description": "UI Data Type" - } - }, - "x-stoplight": { - "id": "v26r0c9hlimtv" - } - }, - "Gallery": { - "description": "Model for Gallery", - "examples": [ - { - "alias": "string", - "columns": [ - { - "fk_col_id": "string", - "fk_gallery_id": "string", - "help": "string", - "id": "string", - "label": "string" - } - ], - "cover_image": "string", - "cover_image_idx": 0, - "deleted": true, - "fk_cover_image_col_id": "string", - "fk_model_id": "string", - "fk_view_id": "string", - "lock_type": "collaborative", - "next_enabled": true, - "order": 0, - "prev_enabled": true, - "restrict_number": "string", - "restrict_size": "string", - "restrict_types": "string", - "title": "string" - } - ], - "properties": { - "alias": { - "type": "string" - }, - "columns": { - "items": { - "$ref": "#/components/schemas/GalleryColumn" - }, - "type": "array" - }, - "cover_image": { - "type": "string" - }, - "cover_image_idx": { - "type": "integer" - }, - "deleted": { - "$ref": "#/components/schemas/Bool" - }, - "fk_cover_image_col_id": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Foreign Key to Cover Image Column" - }, - "fk_model_id": { - "type": "string", - "description": "Foreign Key to Model" - }, - "fk_view_id": { - "type": "string", - "description": "Foreign Key to View" - }, - "lock_type": { - "enum": ["collaborative", "locked", "personal"], - "type": "string" - }, - "next_enabled": { - "$ref": "#/components/schemas/Bool" - }, - "order": { - "type": "number", - "description": "Order of Gallery" - }, - "prev_enabled": { - "$ref": "#/components/schemas/Bool" - }, - "restrict_number": { - "type": "string" - }, - "restrict_size": { - "type": "string" - }, - "restrict_types": { - "type": "string" - }, - "title": { - "type": "string" - } - }, - "title": "Gallery Model", - "type": "object", - "x-stoplight": { - "id": "i0h7av37o4eks" - } - }, - "GalleryColumn": { - "description": "Model for Gallery Column", - "examples": [ - { - "fk_col_id": "string", - "fk_gallery_id": "string", - "help": "string", - "id": "string", - "label": "string" - } - ], - "properties": { - "fk_col_id": { - "type": "string" - }, - "fk_gallery_id": { - "type": "string" - }, - "help": { - "type": "string" - }, - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "label": { - "type": "string" - } - }, - "title": "Gallery Column Model", - "type": "object", - "x-stoplight": { - "id": "jdhvl7gb33fqo" - } - }, - "GalleryUpdateReq": { - "description": "Model for Gallery View Update Request", - "x-stoplight": { - "id": "x57k1fq4101e1" - }, - "examples": [ - { - "fk_cover_image_col_id": "cl_ib8l4j1kiu1efx", - "meta": null - } - ], - "title": "Gallery View Update Request Model", - "type": "object", - "properties": { - "fk_cover_image_col_id": { - "$ref": "#/components/schemas/StringOrNull", - "description": "The id of the column that contains the cover image" - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "x-stoplight": { - "id": "zhp6jkrr54wuf" - }, - "description": "Meta Info" - } - } - }, - "GeoLocation": { - "description": "Model for Geo Location", - "examples": [ - { - "latitude": 18.52139, - "longitude": 179.87295 - } - ], - "properties": { - "latitude": { - "description": "The latitude of the location", - "example": 18.52139, - "exclusiveMaximum": 90, - "exclusiveMinimum": -90, - "format": "double", - "type": "number" - }, - "longitude": { - "description": "The longitude of the location", - "example": 179.87295, - "exclusiveMaximum": 180, - "exclusiveMinimum": -180, - "format": "double", - "type": "number" - } - }, - "title": "Geo Location Model", - "type": "object", - "x-stoplight": { - "id": "685e1l91iuxhv" - } - }, - "Grid": { - "description": "Model for Grid", - "examples": [ - { - "project_id": "p_xm3thidrblw4n7", - "base_id": "ds_g4ccx6e77h1dmi", - "fk_view_id": "vw_p2jcatxz4mvcfw", - "row_height": 1, - "meta": null, - "columns": [ - { - "id": "cl_phvuuwjrzcdo0g", - "base_id": "ds_g4ccx6e77h1dmi", - "project_id": "p_xm3thidrblw4n7", - "fk_model_id": "md_rsu68aqjsbyqtl", - "title": "Id", - "column_name": "id", - "uidt": "ID", - "dt": "int", - "np": "10", - "ns": "0", - "clen": null, - "cop": "1", - "pk": 1, - "pv": null, - "rqd": 1, - "un": 1, - "ct": "int unsigned", - "ai": 1, - "unique": 0, - "cdf": null, - "cc": "", - "csn": null, - "dtx": "specificType", - "dtxp": "", - "dtxs": "0", - "au": 0, - "validate": null, - "virtual": null, - "deleted": null, - "system": 0, - "order": 1, - "created_at": "2023-03-02 17:04:06", - "updated_at": "2023-03-02 17:04:06", - "meta": null - } - ] - } - ], - "title": "Grid Model", - "type": "object", - "properties": { - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID", - "x-stoplight": { - "id": "e3ti3fc0ocjyu" - } - }, - "project_id": { - "$ref": "#/components/schemas/Id", - "description": "Project ID", - "x-stoplight": { - "id": "e3ti3fc0ocjyu" - } - }, - "base_id": { - "$ref": "#/components/schemas/Id", - "description": "Base ID", - "x-stoplight": { - "id": "m8v3iyf1tidy9" - } - }, - "fk_view_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to View", - "x-stoplight": { - "id": "m8v3iyf1tidy9" - } - }, - "row_height": { - "type": "number", - "example": 1, - "description": "Row Height" - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "x-stoplight": { - "id": "n8cud3jyqw5yv" - }, - "description": "Meta info for Grid Model" - }, - "columns": { - "type": "array", - "x-stoplight": { - "id": "22y0gipx2jdf8" - }, - "description": "Grid View Columns", - "items": { - "$ref": "#/components/schemas/GridColumn", - "x-stoplight": { - "id": "nmzp6w3o6b24u" - } - } - } - }, - "x-stoplight": { - "id": "1xswddf91q5pu" - } - }, - "Grid - copy": { - "description": "Model for Grid", - "x-stoplight": { - "id": "xheueli0578g0" - }, - "examples": [ - { - "project_id": "p_xm3thidrblw4n7", - "base_id": "ds_g4ccx6e77h1dmi", - "fk_view_id": "vw_p2jcatxz4mvcfw", - "row_height": 1, - "meta": null, - "columns": [ - { - "id": "cl_phvuuwjrzcdo0g", - "base_id": "ds_g4ccx6e77h1dmi", - "project_id": "p_xm3thidrblw4n7", - "fk_model_id": "md_rsu68aqjsbyqtl", - "title": "Id", - "column_name": "id", - "uidt": "ID", - "dt": "int", - "np": "10", - "ns": "0", - "clen": null, - "cop": "1", - "pk": 1, - "pv": null, - "rqd": 1, - "un": 1, - "ct": "int unsigned", - "ai": 1, - "unique": 0, - "cdf": null, - "cc": "", - "csn": null, - "dtx": "specificType", - "dtxp": "", - "dtxs": "0", - "au": 0, - "validate": null, - "virtual": null, - "deleted": null, - "system": 0, - "order": 1, - "created_at": "2023-03-02 17:04:06", - "updated_at": "2023-03-02 17:04:06", - "meta": null - } - ] - } - ], - "title": "Grid Model", - "type": "object", - "properties": { - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID", - "x-stoplight": { - "id": "e3ti3fc0ocjyu" - } - }, - "project_id": { - "$ref": "#/components/schemas/Id", - "description": "Project ID", - "x-stoplight": { - "id": "e3ti3fc0ocjyu" - } - }, - "base_id": { - "$ref": "#/components/schemas/Id", - "description": "Base ID", - "x-stoplight": { - "id": "m8v3iyf1tidy9" - } - }, - "fk_view_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to View", - "x-stoplight": { - "id": "m8v3iyf1tidy9" - } - }, - "row_height": { - "type": "number", - "example": 1, - "description": "Row Height" - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "x-stoplight": { - "id": "n8cud3jyqw5yv" - }, - "description": "Meta info for Grid Model" - }, - "columns": { - "type": "array", - "x-stoplight": { - "id": "22y0gipx2jdf8" - }, - "description": "Grid View Columns", - "items": { - "$ref": "#/components/schemas/GridColumn", - "x-stoplight": { - "id": "nmzp6w3o6b24u" - } - } - } - } - }, - "GridColumn": { - "description": "Model for Grid Column", - "examples": [ - { - "id": "nc_c8jz4kxe6xvh11", - "fk_view_id": "vw_p2jcatxz4mvcfw", - "fk_column_id": "cl_c5knoi4xs4sfpt", - "project_id": "p_xm3thidrblw4n7", - "base_id": "ds_g4ccx6e77h1dmi", - "show": 0, - "order": 1, - "width": "200px", - "help": null - } - ], - "title": "Grid Column Model", - "type": "object", - "properties": { - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID", - "x-stoplight": { - "id": "jc14yojp52rqj" - } - }, - "fk_view_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to View", - "x-stoplight": { - "id": "vl18dbt5c2r8r" - } - }, - "fk_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Column", - "x-stoplight": { - "id": "2drg88fmodf3v" - } - }, - "project_id": { - "$ref": "#/components/schemas/Id", - "description": "Project ID", - "x-stoplight": { - "id": "2drg88fmodf3v" - } - }, - "base_id": { - "$ref": "#/components/schemas/Id", - "description": "Base ID", - "x-stoplight": { - "id": "2drg88fmodf3v" - } - }, - "show": { - "$ref": "#/components/schemas/Bool", - "x-stoplight": { - "id": "d47eer13oa8yr" - } - }, - "order": { - "type": "number", - "x-stoplight": { - "id": "d47eer13oa8yr" - }, - "example": 1, - "description": "Grid Column Order" - }, - "width": { - "type": "string", - "description": "Column Width", - "example": "200px" - }, - "help": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Column Help Text", - "x-stoplight": { - "id": "azwh6zn37qzkc" - } - } - }, - "x-stoplight": { - "id": "g06nri6t6h6ke" - } - }, - "GridColumnReq": { - "description": "Model for Grid Column Request", - "examples": [ - { - "fk_column_id": "cl_c5knoi4xs4sfpt", - "label": "My Column", - "width": "200px" - } - ], - "properties": { - "fk_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Column" - }, - "help": { - "maxLength": 255, - "type": "string" - }, - "label": { - "description": "The label of the column", - "example": "My Column", - "maxLength": 255, - "type": "string" - }, - "width": { - "description": "The width of the column", - "example": "200px", - "maxLength": 255, - "pattern": "^[0-9]+(px|%)$", - "type": "string" - } - }, - "title": "Grid Column Request Model", - "type": "object", - "x-stoplight": { - "id": "8v9cxve0332zg" - } - }, - "GridUpdateReq": { - "description": "Model for Grid View Update", - "x-stoplight": { - "id": "g10t5gray4bk5" - }, - "examples": [ - { - "row_height": "1", - "meta": null - } - ], - "title": "Grid View Update Model", - "type": "object", - "properties": { - "row_height": { - "type": "number", - "x-stoplight": { - "id": "m5976ax1q13cr" - }, - "description": "Row Height", - "example": 1 - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "x-stoplight": { - "id": "dugbkhe9iupqu" - }, - "description": "Meta Info for grid view" - } - } - }, - "Hook": { - "description": "Model for Hook", - "examples": [ - { - "active": 0, - "async": 0, - "description": "This is my hook description", - "env": "all", - "event": "after", - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "string", - "notification": "{\"type\":\"URL\",\"payload\":{\"method\":\"POST\",\"body\":\"{{ json data }}\",\"headers\":[{}],\"parameters\":[{}],\"auth\":\"\",\"path\":\"http://example.com\"}}", - "null": null, - "operation": "insert", - "retries": 10, - "retry_interval": 60000, - "timeout": 60000, - "title": "My Webhook" - } - ], - "title": "Hook Model", - "type": "object", - "x-stoplight": { - "id": "32blg2oqo6g7p" - }, - "properties": { - "active": { - "$ref": "#/components/schemas/Bool", - "description": "Is the hook active?" - }, - "async": { - "$ref": "#/components/schemas/Bool", - "description": "Is the hook aysnc?" - }, - "description": { - "type": "string", - "description": "Hook Description", - "example": "This is my hook description" - }, - "env": { - "type": "string", - "example": "all", - "description": "Environment for the hook" - }, - "event": { - "enum": ["after", "before"], - "type": "string", - "description": "Event Type for the operation", - "example": "after" - }, - "fk_model_id": { - "type": "string", - "description": "Foreign Key to Model", - "example": "md_rsu68aqjsbyqtl" - }, - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "notification": { - "description": "Hook Notification including info such as type, payload, method, body, and etc", - "type": ["object", "string"] - }, - "operation": { - "enum": [ - "insert", - "update", - "delete", - "bulkInsert", - "bulkUpdate", - "bulkDelete" - ], - "type": "string", - "description": "Hook Operation", - "example": "insert" - }, - "retries": { - "type": "number", - "description": "Retry Count", - "example": 10 - }, - "retry_interval": { - "type": "number", - "description": "Retry Interval", - "example": 60000 - }, - "timeout": { - "type": "number", - "example": 60000, - "description": "Timeout" - }, - "title": { - "type": "string", - "description": "Hook Title", - "example": "My Webhook" - }, - "type": { - "type": "string", - "description": "Hook Type" - }, - "version": { - "type": "string", - "x-stoplight": { - "id": "socewqvadj91n" - }, - "example": "v2", - "description": "Hook Version", - "enum": ["v1", "v2"] - } - } - }, - "HookReq": { - "description": "Model for Hook", - "x-stoplight": { - "id": "85vr8fx3oea31" - }, - "examples": [ - { - "active": 0, - "async": 0, - "description": "This is my hook description", - "env": "all", - "event": "after", - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "string", - "notification": "{\"type\":\"URL\",\"payload\":{\"method\":\"POST\",\"body\":\"{{ json data }}\",\"headers\":[{}],\"parameters\":[{}],\"auth\":\"\",\"path\":\"http://example.com\"}}", - "null": null, - "operation": "insert", - "retries": 10, - "retry_interval": 60000, - "timeout": 60000, - "title": "My Webhook", - "condition": false - } - ], - "title": "Hook Request Model", - "type": "object", - "properties": { - "active": { - "$ref": "#/components/schemas/Bool", - "description": "Is the hook active?" - }, - "async": { - "$ref": "#/components/schemas/Bool", - "description": "Is the hook aysnc?" - }, - "description": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Hook Description" - }, - "env": { - "type": "string", - "example": "all", - "description": "Environment for the hook" - }, - "event": { - "enum": ["after", "before"], - "type": "string", - "description": "Event Type for the operation", - "example": "after" - }, - "fk_model_id": { - "type": "string", - "description": "Foreign Key to Model", - "example": "md_rsu68aqjsbyqtl" - }, - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "notification": { - "description": "Hook Notification including info such as type, payload, method, body, and etc", - "type": ["object", "string"] - }, - "operation": { - "enum": [ - "insert", - "update", - "delete", - "bulkInsert", - "bulkUpdate", - "bulkDelete" - ], - "type": "string", - "description": "Hook Operation", - "example": "insert" - }, - "retries": { - "type": "number", - "description": "Retry Count", - "example": 10 - }, - "retry_interval": { - "type": "number", - "description": "Retry Interval", - "example": 60000 - }, - "timeout": { - "type": "number", - "example": 60000, - "description": "Timeout" - }, - "title": { - "type": "string", - "description": "Hook Title", - "example": "My Webhook" - }, - "type": { - "type": ["string", "null"], - "description": "Hook Type" - }, - "condition": { - "$ref": "#/components/schemas/Bool", - "x-stoplight": { - "id": "wwzoum7rrlwun" - }, - "description": "Is this hook assoicated with some filters" - } - }, - "required": ["event", "notification", "operation", "title"] - }, - "HookList": { - "description": "Model for Hook List", - "examples": [ - { - "list": [ - { - "active": 0, - "async": 0, - "description": "This is my hook description", - "env": "all", - "event": "after", - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "string", - "notification": "{\"type\":\"URL\",\"payload\":{\"method\":\"POST\",\"body\":\"{{ json data }}\",\"headers\":[{}],\"parameters\":[{}],\"auth\":\"\",\"path\":\"http://example.com\"}}", - "null": null, - "operation": "insert", - "retries": 10, - "retry_interval": 60000, - "timeout": 60000, - "title": "My Webhook" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - ], - "title": "Hook List Model", - "type": "object", - "x-examples": { - "example-1": { - "bases": { - "list": [ - { - "alias": "string", - "database": "string", - "host": "string", - "id": "string", - "params": "string", - "password": "string", - "port": 0, - "project_id": "string", - "ssl": "string", - "type": "string", - "url": "string", - "username": "string" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "pageSize": 0, - "sort": "string", - "totalRows": 0 - } - } - } - }, - "properties": { - "list": { - "minItems": 1, - "type": "array", - "uniqueItems": true, - "description": "List of hook objects", - "items": { - "$ref": "#/components/schemas/Hook" - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated" - } - }, - "required": ["list", "pageInfo"], - "x-stoplight": { - "id": "n2sbatqu55day" - } - }, - "HookLog": { - "description": "Model for Hook Log", - "examples": [ - { - "base_id": "ds_jxuewivwbxeum2", - "event": "after", - "execution_time": "98", - "fk_hook_id": "hk_035ijv5qdi97y5", - "id": "string", - "notifications": "{\"type\":\"URL\",\"payload\":{\"method\":\"POST\",\"body\":\"{{ json data }}\",\"headers\":[{}],\"parameters\":[{}],\"auth\":\"\",\"path\":\"https://webhook.site/6eb45ce5-b611-4be1-8b96-c2965755662b\"}}", - "operation": "insert", - "payload": "{\"method\":\"POST\",\"body\":\"{{ json data }}\",\"headers\":[{}],\"parameters\":[{}],\"auth\":\"\",\"path\":\"https://webhook.site/6eb45ce5-b611-4be1-8b96-c2965755662b\"}", - "project_id": "p_tbhl1hnycvhe5l", - "response": "{\"status\":200,\"statusText\":\"OK\",\"headers\":{\"server\":\"nginx\",\"content-type\":\"text/plain; charset=UTF-8\",\"transfer-encoding\":\"chunked\",\"connection\":\"close\",\"vary\":\"Accept-Encoding\",\"x-request-id\":\"53844a7d-ede8-4798-adf7-8af441908a72\",\"x-token-id\":\"6eb45ce5-b611-4be1-8b96-c2965755662b\",\"cache-control\":\"no-cache, private\",\"date\":\"Fri, 24 Mar 2023 10:50:10 GMT\"},\"config\":{\"url\":\"https://webhook.site/6eb45ce5-b611-4be1-8b96-c2965755662b\",\"method\":\"post\",\"data\":\"{\\\"type\\\":\\\"records.after.insert\\\",\\\"id\\\":\\\"a77d97dc-a3e4-4719-9b46-45f93e0cc99a\\\",\\\"data\\\":{\\\"table_id\\\":\\\"md_d8v403o74mf5lf\\\",\\\"table_name\\\":\\\"Sheet-2\\\"}}\",\"headers\":{\"Accept\":\"application/json, text/plain, */*\",\"Content-Type\":\"application/x-www-form-urlencoded\",\"User-Agent\":\"axios/0.21.4\",\"Content-Length\":138},\"params\":{}}}", - "test_call": 0, - "triggered_by": "w@nocodb.com", - "type": "URL" - } - ], - "title": "Hook Log Model", - "type": "object", - "x-stoplight": { - "id": "ni303795b18y5" - }, - "properties": { - "base_id": { - "type": "string", - "description": "Unique Base ID", - "example": "ds_jxuewivwbxeum2" - }, - "conditions": { - "type": "string", - "description": "Hook Conditions" - }, - "error": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Error" - }, - "error_code": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Error Code" - }, - "error_message": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Error Message" - }, - "event": { - "type": "string", - "description": "Hook Event", - "example": "after", - "enum": ["after", "before"] - }, - "execution_time": { - "type": "string", - "description": "Execution Time in milliseconds", - "example": "98" - }, - "fk_hook_id": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Foreign Key to Hook" - }, - "id": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Unique ID" - }, - "notifications": { - "type": "string", - "description": "Hook Notification" - }, - "operation": { - "type": "string", - "description": "Hook Operation", - "enum": [ - "insert", - "update", - "delete", - "bulkInsert", - "bulkUpdate", - "bulkDelete" - ], - "example": "insert" - }, - "payload": { - "type": "string", - "description": "Hook Payload", - "example": "{\"method\":\"POST\",\"body\":\"{{ json data }}\",\"headers\":[{}],\"parameters\":[{}],\"auth\":\"\",\"path\":\"https://webhook.site/6eb45ce5-b611-4be1-8b96-c2965755662b\"}" - }, - "project_id": { - "type": "string", - "description": "Project ID", - "example": "p_tbhl1hnycvhe5l" - }, - "response": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Hook Response" - }, - "test_call": { - "$ref": "#/components/schemas/Bool", - "description": "Is this testing hook call?" - }, - "triggered_by": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Who triggered the hook?" - }, - "type": { - "type": "string", - "example": "URL", - "description": "Hook Type" - } - } - }, - "HookLogList": { - "description": "Model for Hook Log List", - "x-stoplight": { - "id": "tfv7y629w2ap2" - }, - "examples": [], - "title": "Hook Log List Model", - "type": "object", - "x-examples": { - "example-1": { - "bases": { - "list": [ - { - "alias": "string", - "database": "string", - "host": "string", - "id": "string", - "params": "string", - "password": "string", - "port": 0, - "project_id": "string", - "ssl": "string", - "type": "string", - "url": "string", - "username": "string" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "pageSize": 0, - "sort": "string", - "totalRows": 0 - } - } - } - }, - "properties": { - "list": { - "minItems": 1, - "type": "array", - "uniqueItems": true, - "description": "List of hook objects", - "items": { - "$ref": "#/components/schemas/HookLog" - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated" - } - }, - "required": ["list", "pageInfo"] - }, - "HookTestReq": { - "description": "Model for Hook Test Request", - "examples": [ - { - "hook": { - "active": 0, - "async": 0, - "description": "This is my hook description", - "env": "all", - "event": "after", - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "string", - "notification": "{\"type\":\"URL\",\"payload\":{\"method\":\"POST\",\"body\":\"{{ json data }}\",\"headers\":[{}],\"parameters\":[{}],\"auth\":\"\",\"path\":\"http://example.com\"}}", - "null": null, - "operation": "insert", - "retries": 10, - "retry_interval": 60000, - "timeout": 60000, - "title": "My Webhook" - }, - "payload": { - "data": { - "Id": 1, - "Title": "Sample Text", - "CreatedAt": "2023-03-03T10:03:06.484Z", - "UpdatedAt": "2023-03-03T10:03:06.484Z", - "attachment": [ - { - "url": "https://nocodb.com/dummy.png", - "title": "image.png", - "mimetype": "image/png", - "size": 0 - } - ], - "f": "Sample Output" - } - } - } - ], - "title": "Hook Test Request Model", - "type": "object", - "properties": { - "hook": { - "$ref": "#/components/schemas/HookReq" - }, - "payload": { - "description": "Payload to be sent" - } - }, - "required": ["hook", "payload"], - "x-stoplight": { - "id": "w64q11jiv01np" - } - }, - "Id": { - "description": "Model for ID", - "examples": ["string"], - "maxLength": 20, - "minLength": 0, - "title": "ID Model", - "type": "string", - "x-stoplight": { - "id": "obj8r7jhyfoqg" - } - }, - "Kanban": { - "description": "Model for Kanban", - "examples": [ - { - "id": "vw_wqs4zheuo5lgdy", - "fk_grp_col_id": "cl_3704cxcbqt7sj7", - "fk_view_id": "vw_wqs4zheuo5lgdy", - "fk_cover_image_col_id": null, - "columns": [ - { - "id": "kvc_2skkg5mi1eb37f", - "fk_column_id": "cl_hzos4ghyncqi4k", - "fk_view_id": "vw_wqs4zheuo5lgdy", - "base_id": "ds_hd4ojj0xpquaam", - "project_id": "p_kzfl5lb0t3tcok", - "title": "string", - "show": 0, - "order": "1" - } - ], - "meta": null, - "title": "My Kanban" - } - ], - "title": "Kanban Model", - "type": "object", - "properties": { - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "fk_grp_col_id": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Grouping Field Column ID" - }, - "fk_view_id": { - "$ref": "#/components/schemas/Id", - "x-stoplight": { - "id": "1kgw1w06b97nl" - }, - "description": "View ID" - }, - "fk_cover_image_col_id": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Cover Image Column ID" - }, - "columns": { - "type": "array", - "description": "Kanban Columns", - "items": { - "$ref": "#/components/schemas/KanbanColumn" - } - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "description": "Meta Info for Kanban" - }, - "title": { - "type": "string", - "description": "Kanban Title", - "example": "My Kanban" - } - }, - "x-stoplight": { - "id": "sfbbvgbcv7je6" - } - }, - "KanbanColumn": { - "description": "Model for Kanban Column", - "examples": [ - { - "id": "kvc_2skkg5mi1eb37f", - "fk_column_id": "cl_hzos4ghyncqi4k", - "fk_view_id": "vw_wqs4zheuo5lgdy", - "base_id": "ds_hd4ojj0xpquaam", - "project_id": "p_kzfl5lb0t3tcok", - "title": "string", - "show": 0, - "order": "1" - } - ], - "title": "Kanban Column Model", - "type": "object", - "properties": { - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "fk_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Column" - }, - "fk_view_id": { - "$ref": "#/components/schemas/Id", - "x-stoplight": { - "id": "t1fy4zy561ih8" - }, - "description": "Foreign Key to View" - }, - "base_id": { - "$ref": "#/components/schemas/Id", - "x-stoplight": { - "id": "uqq8xmyz97t1u" - }, - "description": "Baes ID\n" - }, - "project_id": { - "$ref": "#/components/schemas/Id", - "x-stoplight": { - "id": "uqq8xmyz97t1u" - }, - "description": "Project ID" - }, - "title": { - "x-stoplight": { - "id": "uqq8xmyz97t1u" - }, - "description": "Project ID", - "type": "string" - }, - "show": { - "$ref": "#/components/schemas/Bool", - "x-stoplight": { - "id": "uqq8xmyz97t1u" - }, - "description": "Is this column shown?" - }, - "order": { - "type": "number", - "x-stoplight": { - "id": "pbnchzgci5dwa" - }, - "example": 1, - "description": "Column Order" - } - }, - "x-stoplight": { - "id": "epfedw9ccxgxe" - } - }, - "KanbanUpdateReq": { - "description": "Model for Kanban Update Request", - "examples": [ - { - "fk_grp_col_id": "cl_g0a89q9xdry3lu", - "fk_cover_image_col_id": "cl_ib8l4j1kiu1efx", - "meta": { - "cl_g0a89q9xdry3lu": [ - { - "id": "uncategorized", - "title": null, - "order": 0, - "color": "#c2f5e8", - "collapsed": false - }, - { - "id": "sl_ihyva6jx6dg0fc", - "fk_column_id": "cl_g0a89q9xdry3lu", - "title": "a", - "color": "#cfdffe", - "order": 1, - "collapsed": false - }, - { - "id": "sl_gqdm5v6t8aetoa", - "fk_column_id": "cl_g0a89q9xdry3lu", - "title": "b", - "color": "#d0f1fd", - "order": 2, - "collapsed": false - }, - { - "id": "sl_eipnl0kn7a9d3c", - "fk_column_id": "cl_g0a89q9xdry3lu", - "title": "cc", - "color": "#c2f5e8", - "order": 3, - "collapsed": false - }, - { - "id": "sl_dei8p2jq0cnlv0", - "fk_column_id": "cl_g0a89q9xdry3lu", - "title": "d", - "color": "#ffdaf6", - "order": 4, - "collapsed": false - } - ] - } - } - ], - "title": "Kanban Update Request Model", - "type": "object", - "properties": { - "fk_grp_col_id": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Foreign Key to Grouping Field Column" - }, - "fk_cover_image_col_id": { - "$ref": "#/components/schemas/StringOrNull", - "x-stoplight": { - "id": "81wn4hzj76wod" - }, - "description": "Foreign Key to Cover Image Column" - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "x-stoplight": { - "id": "stsvdmkli1b0r" - }, - "description": "Meta Info" - } - }, - "x-stoplight": { - "id": "b1jlyk12kfuwx" - } - }, - "LicenseReq": { - "description": "Model for Kanban Request", - "examples": [ - { - "key": "1234567890" - } - ], - "properties": { - "key": { - "description": "The license key", - "example": "1234567890", - "maxLength": 255, - "minLength": 10, - "type": "string" - } - }, - "title": "License Key Request Model", - "type": "object", - "x-stoplight": { - "id": "trgk6qlmgdyfo" - } - }, - "LinkToAnotherColumnReq": { - "description": "Model for LinkToAnotherColumn Request", - "examples": [ - { - "childId": "string", - "parentId": "string", - "title": "string", - "type": "hm", - "uidt": "LinkToAnotherRecord", - "virtual": true - } - ], - "properties": { - "childId": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to chhild column" - }, - "parentId": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to parent column" - }, - "title": { - "maxLength": 255, - "minLength": 1, - "type": "string", - "description": "The title of the virtual column" - }, - "type": { - "enum": ["bt", "hm", "mm"], - "type": "string", - "description": "The type of the relationship" - }, - "uidt": { - "enum": ["LinkToAnotherRecord"], - "type": "string", - "description": "Abstract type of the relationship" - }, - "virtual": { - "$ref": "#/components/schemas/Bool", - "description": "Is this relationship virtual?" - } - }, - "required": ["childId", "parentId", "title", "type", "uidt"], - "title": "LinkToAnotherColumn Request Model", - "type": "object", - "x-stoplight": { - "id": "x59gz5reg12x3" - } - }, - "LinkToAnotherRecord": { - "description": "Model for LinkToAnotherRecord", - "examples": [ - { - "deleted": "string", - "dr": "string", - "fk_child_column_id": "string", - "fk_column_id": "string", - "fk_index_name": "string", - "fk_mm_child_column_id": "string", - "fk_mm_model_id": "string", - "fk_mm_parent_column_id": "string", - "fk_parent_column_id": "string", - "fk_related_model_id": "string", - "id": "string", - "order": "string", - "type": "string", - "ur": "string", - "virtual": true - } - ], - "properties": { - "deleted": { - "type": "string" - }, - "dr": { - "type": "string" - }, - "fk_child_column_id": { - "type": "string" - }, - "fk_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Column" - }, - "fk_index_name": { - "type": "string" - }, - "fk_mm_child_column_id": { - "type": "string" - }, - "fk_mm_model_id": { - "type": "string" - }, - "fk_mm_parent_column_id": { - "type": "string" - }, - "fk_parent_column_id": { - "type": "string" - }, - "fk_related_model_id": { - "type": "string" - }, - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "order": { - "type": "string" - }, - "type": { - "type": "string" - }, - "ur": { - "type": "string" - }, - "virtual": { - "$ref": "#/components/schemas/Bool" - } - }, - "title": "LinkToAnotherRecord Model", - "type": "object", - "x-stoplight": { - "id": "27q0vnr79hxla" - } - }, - "Lookup": { - "description": "Model for Lookup", - "examples": [ - { - "id": "lk_mngsu0e45njbxr", - "fk_column_id": "cl_vdiy9bz7h11kdm", - "fk_relation_column_id": "cl_5jestblzneb649", - "fk_lookup_column_id": "cl_4cm47dtjphgqkv", - "order": 1 - } - ], - "title": "Lookup Model", - "type": "object", - "properties": { - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "fk_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Column" - }, - "fk_lookup_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Lookup Column" - }, - "fk_relation_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Relation Column" - }, - "order": { - "type": "number", - "description": "The order among the list", - "example": 1 - } - }, - "x-stoplight": { - "id": "guyozhka8sx1t" - } - }, - "LookupColumnReq": { - "description": "Model for Lookup Column Request", - "examples": [ - { - "fk_relation_column_id": "cl_5jestblzneb649", - "fk_lookup_column_id": "cl_4cm47dtjphgqkv", - "title": "My Lookup", - "uidt": "Lookup" - } - ], - "title": "Lookup Column Request Model", - "type": "object", - "properties": { - "fk_lookup_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Lookup Column" - }, - "fk_relation_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Relation Column" - }, - "title": { - "maxLength": 255, - "type": "string", - "description": "Lookup Title", - "example": "My Lookup" - }, - "uidt": { - "enum": ["Lookup"], - "type": "string", - "description": "UI DataType" - } - }, - "x-stoplight": { - "id": "hmeckhq2ciwpf" - } - }, - "Map": { - "description": "Model for Map", - "examples": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "columns": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "fk_column_id": "cl_8iw2o4ejzvdyna", - "fk_view_id": "vw_qjt7klod1p9kyv", - "id": "nc_46xcacqn4rc9xf", - "order": 1, - "project_id": "p_xm3thidrblw4n7", - "show": 1 - } - ], - "fk_geo_data_col_id": "cl_8iw2o4ejzvdyna", - "fk_view_id": "vw_qjt7klod1p9kyv", - "meta": {}, - "order": 0, - "project_id": "p_xm3thidrblw4n7", - "show": true, - "title": "My Map" - } - ], - "properties": { - "base_id": { - "description": "The ID of the base that this view belongs to", - "example": "ds_g4ccx6e77h1dmi", - "type": "string" - }, - "columns": { - "description": "Columns in this view", - "items": { - "$ref": "#/components/schemas/MapColumn" - }, - "type": "array" - }, - "fk_geo_data_col_id": { - "description": "Foreign Key to GeoData Column", - "example": "cl_8iw2o4ejzvdyna", - "type": "string" - }, - "fk_view_id": { - "description": "Unique ID for Map", - "example": "vw_qjt7klod1p9kyv", - "type": "string" - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "description": "Meta data for this view" - }, - "order": { - "description": "The order of the map list", - "type": "number" - }, - "project_id": { - "description": "The ID of the project that this view belongs to", - "example": "p_xm3thidrblw4n7", - "type": "string" - }, - "show": { - "description": "To show this Map or not", - "type": "boolean" - }, - "title": { - "description": "Title of Map View", - "example": "My Map", - "type": "string" - } - }, - "title": "Map Model", - "type": "object", - "x-stoplight": { - "id": "hd60sf3k0bs3w" - } - }, - "MapUpdateReq": { - "description": "Model for Map", - "x-stoplight": { - "id": "3hceyh9ukp5ln" - }, - "examples": [ - { - "fk_geo_data_col_id": "cl_8iw2o4ejzvdyna", - "meta": null - } - ], - "title": "Map View Update Request Model", - "type": "object", - "properties": { - "fk_geo_data_col_id": { - "description": "Foreign Key to GeoData Column", - "example": "cl_8iw2o4ejzvdyna", - "type": "string" - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "description": "Meta data for this view" - } - } - }, - "MapColumn": { - "description": "Model for Map Column", - "examples": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "fk_column_id": "cl_8iw2o4ejzvdyna", - "fk_view_id": "vw_qjt7klod1p9kyv", - "id": "nc_46xcacqn4rc9xf", - "order": 1, - "project_id": "p_xm3thidrblw4n7", - "show": 1 - } - ], - "properties": { - "base_id": { - "description": "The ID of the base that this map column belongs to", - "example": "ds_g4ccx6e77h1dmi", - "type": "string" - }, - "fk_column_id": { - "description": "Foreign Key to Column", - "example": "cl_8iw2o4ejzvdyna", - "type": "string" - }, - "fk_view_id": { - "description": "Foreign Key to View", - "example": "vw_qjt7klod1p9kyv", - "type": "string" - }, - "id": { - "description": "Unique ID of Map Column", - "example": "nc_46xcacqn4rc9xf", - "type": "string" - }, - "order": { - "description": "the order in the list of map columns", - "example": 1, - "type": "number" - }, - "project_id": { - "description": "The ID of the project that this map column belongs to", - "example": "p_xm3thidrblw4n7", - "type": "string" - }, - "show": { - "description": "Whether to show this column or not", - "example": 1, - "type": "number" - } - }, - "title": "Map Column Model", - "type": "object", - "x-stoplight": { - "id": "bvk0acuepoqw1" - } - }, - "Meta": { - "description": "Model for Meta", - "examples": [{}], - "oneOf": [ - { - "type": "null" - }, - { - "type": "object" - }, - { - "type": "string" - } - ], - "title": "Meta Model", - "x-stoplight": { - "id": "2ohjoms6hjcym" - } - }, - "ModelRoleVisibility": { - "description": "Model for ModelRoleVisibility", - "examples": [ - { - "base_id": "string", - "disabled": true, - "fk_model_id": "string", - "fk_view_id": "string", - "id": "string", - "project_id": "string", - "role": "string" - } - ], - "properties": { - "base_id": { - "type": "string" - }, - "disabled": { - "$ref": "#/components/schemas/Bool" - }, - "fk_model_id": { - "type": "string" - }, - "fk_view_id": { - "type": "string" - }, - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "project_id": { - "type": "string" - }, - "role": { - "type": "string" - } - }, - "title": "ModelRoleVisibility Model", - "type": "object", - "x-stoplight": { - "id": "68m1dblcswem2" - } - }, - "NormalColumnRequest": { - "description": "Model for Normal Column Request", - "examples": [ - { - "ai": true, - "au": true, - "cc": "string", - "cdf": "string", - "column_name": "string", - "csn": "string", - "dt": "string", - "dtx": "string", - "dtxp": 0, - "dtxs": 0, - "np": 0, - "ns": 0, - "pk": true, - "pv": true, - "rqd": true, - "title": "string", - "uidt": "ID", - "un": true, - "unique": true - } - ], - "properties": { - "ai": { - "$ref": "#/components/schemas/Bool", - "description": "Is this column auto-incremented?" - }, - "au": { - "$ref": "#/components/schemas/Bool", - "description": "Is this column auto-updated datetime field?" - }, - "cc": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Column Comment" - }, - "cdf": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Column Default Value" - }, - "column_name": { - "maxLength": 255, - "minLength": 1, - "type": "string", - "description": "Column Name" - }, - "csn": { - "$ref": "#/components/schemas/StringOrNull" - }, - "dt": { - "type": "string", - "description": "Data Type" - }, - "dtx": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Data Type Extra" - }, - "dtxp": { - "oneOf": [ - { - "$ref": "#/components/schemas/StringOrNull" - }, - { - "type": "number" - } - ], - "description": "Data Type Extra Precision" - }, - "dtxs": { - "oneOf": [ - { - "$ref": "#/components/schemas/StringOrNull" - }, - { - "type": "number" - } - ], - "description": "Data Type Extra Scale" - }, - "np": { - "oneOf": [ - { - "$ref": "#/components/schemas/StringOrNull" - }, - { - "type": "integer" - } - ], - "description": "Numeric Precision" - }, - "ns": { - "oneOf": [ - { - "$ref": "#/components/schemas/StringOrNull" - }, - { - "type": "integer" - } - ], - "description": "Numeric Scale" - }, - "pk": { - "$ref": "#/components/schemas/Bool", - "description": "Is this column a primary key?" - }, - "pv": { - "$ref": "#/components/schemas/Bool", - "description": "Is this column a primary value?" - }, - "rqd": { - "$ref": "#/components/schemas/Bool", - "description": "Is this column required?" - }, - "title": { - "maxLength": 255, - "type": "string", - "description": "Column Title" - }, - "uidt": { - "enum": [ - "Attachment", - "AutoNumber", - "Barcode", - "Button", - "Checkbox", - "Collaborator", - "Count", - "CreateTime", - "Currency", - "Date", - "DateTime", - "Decimal", - "Duration", - "Email", - "Formula", - "ForeignKey", - "GeoData", - "Geometry", - "ID", - "JSON", - "LastModifiedTime", - "LongText", - "LinkToAnotherRecord", - "Lookup", - "MultiSelect", - "Number", - "Percent", - "PhoneNumber", - "Rating", - "Rollup", - "SingleLineText", - "SingleSelect", - "SpecificDBType", - "Time", - "URL", - "Year", - "QrCode" - ], - "type": "string", - "description": "UI Data Type" - }, - "un": { - "$ref": "#/components/schemas/Bool", - "description": "Is this column unique?" - }, - "unique": { - "$ref": "#/components/schemas/Bool", - "description": "Is this column unique?" - } - }, - "title": "Normal Column Request Model", - "type": "object", - "required": ["column_name"], - "x-stoplight": { - "id": "b67hswwa49t9u" - } - }, - "OrgUserReq": { - "description": "Model for Organisation User Update Request", - "examples": [ - { - "email": "user@example.com", - "roles": "org-level-creator" - } - ], - "properties": { - "email": { - "format": "email", - "type": "string" - }, - "roles": { - "enum": ["org-level-creator", "org-level-viewer"], - "type": "string", - "description": "Roles for the project user" - } - }, - "title": "Organisation User Request Model", - "type": "object", - "x-stoplight": { - "id": "hs5aforkqjbkb" - } - }, - "Paginated": { - "description": "Model for Paginated", - "examples": [ - { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - ], - "properties": { - "isFirstPage": { - "description": "Is the current page the first page", - "type": "boolean" - }, - "isLastPage": { - "description": "Is the current page the last page", - "type": "boolean" - }, - "page": { - "description": "The current page", - "example": 1, - "type": "number" - }, - "pageSize": { - "description": "The number of pages", - "example": 10, - "type": "number" - }, - "totalRows": { - "description": "The number of rows in the given result", - "example": 1, - "type": "number" - } - }, - "title": "Paginated Model", - "type": "object", - "x-stoplight": { - "id": "ny0v2losvmitz" - } - }, - "Password": { - "description": "Model for Password", - "example": "password123456789", - "examples": ["password123456789"], - "minLength": 8, - "title": "Password Model", - "type": "string", - "x-stoplight": { - "id": "c6iocwuo2j8z8" - } - }, - "PasswordChangeReq": { - "description": "Model for Password Change Request", - "examples": [ - { - "currentPassword": "currentpassword", - "newPassword": "newpassword" - } - ], - "properties": { - "currentPassword": { - "type": "string" - }, - "newPassword": { - "minLength": 8, - "type": "string" - } - }, - "required": ["currentPassword", "newPassword"], - "title": "Password Change Request Model", - "type": "object", - "x-stoplight": { - "id": "99dogahvh0gla" - } - }, - "PasswordForgotReq": { - "description": "Model for Password Forgot Request", - "examples": [ - { - "email": "user@example.com" - } - ], - "properties": { - "email": { - "description": "Email address of the user", - "format": "email", - "type": "string" - } - }, - "required": ["email"], - "title": "Password Forgot Request Model", - "type": "object", - "x-stoplight": { - "id": "1kkft7m54ax45" - } - }, - "PasswordResetReq": { - "description": "Model for Password Reset Request", - "examples": [ - { - "password": "newpassword" - } - ], - "properties": { - "password": { - "description": "New password", - "example": "newpassword", - "minLength": 8, - "type": "string" - } - }, - "required": ["password"], - "title": "Password Reset Request Model", - "type": "object", - "x-stoplight": { - "id": "i3gzz403zjwh8" - } - }, - "Plugin": { - "description": "Model for Plugin", - "examples": [ - { - "id": "nc_tljibbzcyjrhcc", - "title": "S3", - "description": "Amazon Simple Storage Service (Amazon S3) is an object storage service that offers industry-leading scalability, data availability, security, and performance.", - "active": true, - "rating": null, - "version": "0.0.1", - "docs": null, - "status": "install", - "status_details": null, - "logo": "plugins/s3.png", - "icon": null, - "tags": "Storage", - "category": "Storage", - "input_schema": "{\"title\":\"Configure Amazon S3\",\"items\":[{\"key\":\"bucket\",\"label\":\"Bucket Name\",\"placeholder\":\"Bucket Name\",\"type\":\"SingleLineText\",\"required\":true},{\"key\":\"region\",\"label\":\"Region\",\"placeholder\":\"Region\",\"type\":\"SingleLineText\",\"required\":true},{\"key\":\"access_key\",\"label\":\"Access Key\",\"placeholder\":\"Access Key\",\"type\":\"SingleLineText\",\"required\":true},{\"key\":\"access_secret\",\"label\":\"Access Secret\",\"placeholder\":\"Access Secret\",\"type\":\"Password\",\"required\":true}],\"actions\":[{\"label\":\"Test\",\"placeholder\":\"Test\",\"key\":\"test\",\"actionType\":\"TEST\",\"type\":\"Button\"},{\"label\":\"Save\",\"placeholder\":\"Save\",\"key\":\"save\",\"actionType\":\"SUBMIT\",\"type\":\"Button\"}],\"msgOnInstall\":\"Successfully installed and attachment will be stored in AWS S3\",\"msgOnUninstall\":\"\"}", - "input": "{\"bucket\":\"my-bucket\",\"region\":\"us-west-004\",\"access_key\":\"redacted\",\"access_secret\":\"redacted\"}", - "creator": null, - "creator_website": null, - "price": null - } - ], - "title": "Plugin Model", - "type": "object", - "properties": { - "active": { - "$ref": "#/components/schemas/Bool", - "description": "Is plguin active?" - }, - "category": { - "type": "string", - "description": "Plugin Category", - "example": "Storage" - }, - "creator": { - "type": "string", - "description": "Plugin Creator (Not in use)" - }, - "creator_website": { - "type": "string", - "description": "Plugin Creator website (Not in use)" - }, - "description": { - "type": "string", - "description": "Plugin Description", - "example": "Amazon Simple Storage Service (Amazon S3) is an object storage service that offers industry-leading scalability, data availability, security, and performance." - }, - "docs": { - "type": "string", - "description": "Documentation of plugin (Not in use)" - }, - "icon": { - "type": "string", - "description": "Plugin Icon (Not in use)" - }, - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "input": { - "oneOf": [ - { - "$ref": "#/components/schemas/StringOrNull" - }, - { - "type": "integer" - } - ], - "description": "Plugin Input" - }, - "input_schema": { - "type": "string", - "description": "Plugin Input Schema\n" - }, - "logo": { - "type": "string", - "description": "Plugin logo", - "example": "plugins/s3.png" - }, - "price": { - "type": "string", - "description": "Plugin Price (Not in use)" - }, - "rating": { - "type": "number", - "description": "Plugin Rating (Not in use)" - }, - "status": { - "type": "string", - "description": "Plugin Status", - "example": "install" - }, - "status_details": { - "type": "string", - "description": "Not in use" - }, - "tags": { - "type": "string", - "description": "Plugin tags", - "example": "Storage" - }, - "title": { - "type": "string", - "description": "Plugin Title" - }, - "version": { - "type": "string", - "description": "Plugin Version", - "example": "0.0.1" - } - }, - "x-stoplight": { - "id": "uux5n95kbh2r5" - } - }, - "PluginReq": { - "description": "Model for Plugin Request", - "examples": [ - { - "active": 0, - "input": "{\"bucket\":\"my-bucket\",\"region\":\"us-west-004\",\"access_key\":\"redacted\",\"access_secret\":\"redacted\"}" - } - ], - "title": "Plugin Reqeust", - "type": "object", - "properties": { - "active": { - "$ref": "#/components/schemas/Bool", - "description": "Is Plugin Active?" - }, - "input": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Plugin Input" - } - }, - "x-stoplight": { - "id": "pci8zg4wgn3bx" - } - }, - "PluginTestReq": { - "description": "Model for Plugin Test Request", - "examples": [ - { - "title": "Plugin Foo", - "input": "{\"bucket\":\"my-bucket\",\"region\":\"us-west-004\",\"access_key\":\"redacted\",\"access_secret\":\"redacted\"}", - "category": "Email" - } - ], - "title": "Plugin Test Request Model", - "type": "object", - "properties": { - "title": { - "maxLength": 45, - "type": "string", - "description": "Plugin Title" - }, - "input": { - "oneOf": [ - { - "type": "string", - "description": "Plugin Input as JSON string" - }, - { - "description": "Plugin Input", - "type": "object" - } - ] - }, - "category": { - "x-stoplight": { - "id": "rg3i3ov9rs6d0" - }, - "type": "string", - "example": "Email" - } - }, - "required": ["title", "input", "category"], - "x-stoplight": { - "id": "gest5kbecpjdi" - } - }, - "Project": { - "description": "Model for Project", - "examples": [ - { - "bases": [ - { - "alias": "string", - "config": null, - "enabled": true, - "id": "string", - "inflection_column": "camelize", - "inflection_table": "camelize", - "is_meta": true, - "order": 1, - "project_id": "string", - "type": "mysql2", - "updated_at": "2023-03-01 14:27:36" - } - ], - "color": "#24716E", - "created_at": "2023-03-01 14:27:36", - "deleted": true, - "description": "This is my project description", - "id": "p_124hhlkbeasewh", - "is_meta": true, - "meta": {}, - "order": 0, - "prefix": "nc_vm5q__", - "status": "string", - "title": "my-project" - } - ], - "title": "Project Model", - "type": "object", - "properties": { - "bases": { - "description": "List of base models", - "type": "array", - "items": { - "$ref": "#/components/schemas/Base" - } - }, - "color": { - "description": "Primary Theme Color", - "example": "#24716E", - "type": "string" - }, - "deleted": { - "$ref": "#/components/schemas/Bool", - "description": "Is the project deleted" - }, - "description": { - "description": "Project Description", - "example": "This is my project description", - "type": "string" - }, - "id": { - "description": "Unique Project ID", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "is_meta": { - "$ref": "#/components/schemas/Bool" - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "description": "Meta Info such as theme colors" - }, - "order": { - "description": "The order in project list", - "type": "number" - }, - "prefix": { - "description": "Project prefix. Used in XCDB only.", - "example": "nc_vm5q__", - "type": "string" - }, - "status": { - "type": "string" - }, - "title": { - "description": "Project Title", - "example": "my-project", - "type": "string" - } - }, - "x-stoplight": { - "id": "gae6rj3whdnj9" - } - }, - "ProjectList": { - "description": "Model for Project List", - "examples": [ - { - "list": [ - { - "bases": [ - { - "alias": "string", - "config": null, - "created_at": "2023-03-01 14:27:36", - "enabled": true, - "id": "string", - "inflection_column": "camelize", - "inflection_table": "camelize", - "is_meta": true, - "order": 1, - "project_id": "string", - "type": "mysql2", - "updated_at": "2023-03-01 14:27:36" - } - ], - "color": "#24716E", - "created_at": "2023-03-01 14:27:36", - "deleted": true, - "description": "This is my project description", - "id": "p_124hhlkbeasewh", - "is_meta": true, - "meta": {}, - "order": 0, - "prefix": "nc_vm5q__", - "status": "string", - "title": "my-project", - "updated_at": "2023-03-01 14:27:36" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - ], - "title": "Project List Model", - "type": "object", - "x-examples": { - "example-1": { - "bases": { - "list": [ - { - "alias": "string", - "database": "string", - "host": "string", - "id": "string", - "params": "string", - "password": "string", - "port": 0, - "project_id": "string", - "ssl": "string", - "type": "string", - "url": "string", - "username": "string" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "pageSize": 0, - "sort": "string", - "totalRows": 0 - } - } - } - }, - "properties": { - "list": { - "description": "List of Project Models", - "minItems": 1, - "type": "array", - "uniqueItems": true, - "items": { - "$ref": "#/components/schemas/Project" - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated", - "description": "Pagination Info" - } - }, - "required": ["list", "pageInfo"], - "x-stoplight": { - "id": "xbosckfm1h9l0" - } - }, - "ProjectReq": { - "description": "Model for Project Request", - "examples": [ - { - "bases": [ - { - "alias": "My Base", - "config": null, - "inflection_column": "camelize", - "inflection_table": "camelize", - "is_meta": true, - "type": "mysql" - } - ], - "color": "#24716E", - "description": "This is my project description", - "title": "My Project" - } - ], - "properties": { - "bases": { - "description": "Array of Bases", - "items": { - "$ref": "#/components/schemas/BaseReq" - }, - "type": "array" - }, - "color": { - "description": "Primary Theme Color", - "example": "#24716E", - "maxLength": 50, - "type": "string" - }, - "description": { - "description": "Project Description", - "example": "This is my project description", - "type": "string" - }, - "title": { - "description": "Project Title", - "example": "My Project", - "maxLength": 128, - "minLength": 1, - "type": "string" - } - }, - "required": ["title"], - "title": "Project Request Model", - "type": "object", - "x-stoplight": { - "id": "aicbp4keo57ld" - } - }, - "ProjectUpdateReq": { - "description": "Model for Project Update Request", - "x-stoplight": { - "id": "83257b35r118q" - }, - "examples": [ - { - "color": "#24716E", - "meta": null, - "title": "My Project" - } - ], - "title": "Project Update Request Model", - "type": "object", - "properties": { - "color": { - "description": "Primary Theme Color", - "example": "#24716E", - "maxLength": 50, - "type": "string" - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "description": "Project Meta", - "x-stoplight": { - "id": "m05w9sbwqgul3" - } - }, - "title": { - "description": "Project Title", - "example": "My Project", - "maxLength": 128, - "minLength": 1, - "type": "string" - } - } - }, - "ProjectUserReq": { - "description": "Model for Project User Request", - "examples": [ - { - "email": "user@example.com", - "roles": "owner" - } - ], - "title": "Project User Request Model", - "type": "object", - "properties": { - "email": { - "format": "email", - "type": "string", - "description": "Project User Email" - }, - "roles": { - "enum": [ - "commenter", - "editor", - "guest", - "owner", - "viewer", - "creator" - ], - "type": "string", - "description": "Project User Role" - } - }, - "required": ["email", "roles"], - "x-stoplight": { - "id": "tq2wpd2agebjz" - } - }, - "Rollup": { - "description": "Model for Rollup", - "examples": [ - { - "id": "rl_kc19pbdkij8wly", - "fk_column_id": "cl_588b63mneri2yi", - "fk_relation_column_id": "cl_c09q6eu6hsvn4s", - "fk_rollup_column_id": "cl_m62i1vyl23n8co", - "rollup_function": "count" - } - ], - "title": "Rollup Model", - "type": "object", - "properties": { - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "fk_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Column" - }, - "fk_relation_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign to Relation Column" - }, - "fk_rollup_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign to Rollup Column" - }, - "rollup_function": { - "type": "string", - "description": "Rollup Function", - "example": "count", - "enum": [ - "count", - "min", - "max", - "avg", - "countDistinct", - "sumDistinct", - "avgDistinct" - ] - } - }, - "x-stoplight": { - "id": "vdzh0qojyn9a9" - } - }, - "RollupColumnReq": { - "description": "Model for Rollup Column Request", - "examples": [ - { - "fk_relation_column_id": "cl_c09q6eu6hsvn4s", - "fk_rollup_column_id": "cl_m62i1vyl23n8co", - "title": "Rollup Column", - "rollup_function": "avg", - "uidt": "Rollup" - } - ], - "title": "Rollup Column Request Model", - "type": "object", - "properties": { - "fk_relation_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Relation Column" - }, - "fk_rollup_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Rollup Column" - }, - "title": { - "maxLength": 255, - "type": "string", - "description": "Rollup Column Title" - }, - "rollup_function": { - "enum": [ - "avg", - "avgDistinct", - "count", - "countDistinct", - "max", - "min", - "sum", - "sumDistinct" - ], - "type": "string", - "description": "Rollup Function" - }, - "uidt": { - "enum": ["Rollup"], - "type": "string", - "description": "UI DataType" - } - }, - "x-stoplight": { - "id": "uw9fq6lp1lone" - } - }, - "SelectOption": { - "description": "Model for SelectOption", - "examples": [ - { - "id": "sl_hvfeuagqtlzzbk", - "title": "Option A", - "fk_column_id": "cl_35zmvi2tezfipw", - "color": "#cfdffe", - "order": 1 - } - ], - "title": "SelectOption Model", - "type": "object", - "properties": { - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "title": { - "type": "string", - "description": "Option Title\n", - "example": "Option A" - }, - "fk_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Column" - }, - "color": { - "type": "string", - "description": "Option Color", - "example": "#cfdffe" - }, - "order": { - "type": "number", - "description": "The order among the options", - "example": 1 - } - }, - "x-stoplight": { - "id": "onnh5qie1ul32" - } - }, - "SelectOptions": { - "description": "Model for SelectOptions", - "examples": [ - { - "options": [ - { - "id": "sl_hvfeuagqtlzzbk", - "title": "Option A", - "fk_column_id": "cl_35zmvi2tezfipw", - "color": "#cfdffe", - "order": 1 - } - ] - } - ], - "title": "SelectOptions Model", - "type": "object", - "properties": { - "options": { - "type": "array", - "description": "Array of select options", - "items": { - "$ref": "#/components/schemas/SelectOption" - } - } - }, - "required": ["options"], - "x-stoplight": { - "id": "3i68n0spduuf9" - } - }, - "SharedBaseReq": { - "description": "Model for Shared Base Request", - "examples": [ - { - "password": "password123", - "roles": "editor" - } - ], - "title": "Shared Base Request Model", - "type": "object", - "properties": { - "password": { - "minLength": 8, - "type": "string", - "description": "Password to protect the base", - "example": "password123" - }, - "roles": { - "enum": ["commenter", "editor", "viewer"], - "type": "string", - "description": "The role given the target user", - "example": "editor" - } - }, - "x-stoplight": { - "id": "ep7ikmx3sudcl" - } - }, - "SharedView": { - "$ref": "#/components/schemas/View", - "description": "Model for Shared View", - "title": "SharedView", - "examples": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:46:31", - "fk_model_id": "md_mhs9z4r2ak98x0", - "id": "vw_lg052cnc1c26kf", - "is_default": 1, - "lock_type": "collaborative", - "meta": {}, - "order": 1, - "password": null, - "project_id": "p_xm3thidrblw4n7", - "show": 1, - "show_system_fields": null, - "title": "Sheet-1", - "type": 3, - "updated_at": "2023-03-02 17:46:31", - "uuid": null, - "view": { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:46:31", - "fk_view_id": "vw_lg052cnc1c26kf", - "meta": null, - "project_id": "p_xm3thidrblw4n7", - "row_height": null, - "updated_at": "2023-03-02 17:46:31", - "uuid": null - } - } - ], - "x-stoplight": { - "id": "fqfohevz2zj4u" - } - }, - "SharedViewList": { - "description": "Model for Shared View List", - "examples": [ - { - "list": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:46:31", - "fk_model_id": "md_mhs9z4r2ak98x0", - "id": "vw_lg052cnc1c26kf", - "is_default": 1, - "lock_type": "collaborative", - "meta": {}, - "order": 1, - "password": null, - "project_id": "p_xm3thidrblw4n7", - "show": 1, - "show_system_fields": null, - "title": "Sheet-1", - "type": 3, - "updated_at": "2023-03-02 17:46:31", - "uuid": null, - "view": { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:46:31", - "fk_view_id": "vw_lg052cnc1c26kf", - "meta": null, - "project_id": "p_xm3thidrblw4n7", - "row_height": null, - "updated_at": "2023-03-02 17:46:31", - "uuid": null - } - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - ], - "title": "Shared View List Model", - "type": "object", - "x-examples": { - "example-1": { - "bases": { - "list": [ - { - "alias": "string", - "database": "string", - "host": "string", - "id": "string", - "params": "string", - "password": "string", - "port": 0, - "project_id": "string", - "ssl": "string", - "type": "string", - "url": "string", - "username": "string" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "pageSize": 0, - "sort": "string", - "totalRows": 0 - } - } - } - }, - "properties": { - "list": { - "minItems": 1, - "type": "array", - "uniqueItems": true, - "description": "List of shared view objects", - "items": { - "$ref": "#/components/schemas/SharedView" - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated", - "description": "Paginated Info" - } - }, - "required": ["list", "pageInfo"], - "x-stoplight": { - "id": "zdpekhmw0wvj3" - } - }, - "SharedViewReq": { - "description": "Model for Shared View Request", - "examples": [ - { - "meta": {}, - "password": "123456789" - } - ], - "title": "Shared View Request Model", - "type": "object", - "properties": { - "meta": { - "$ref": "#/components/schemas/Meta", - "description": "Meta data passing to Shared View such as if download is allowed or not." - }, - "password": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Password to restrict access" - } - }, - "x-stoplight": { - "id": "0g3o2uo9y4h4g" - } - }, - "SignInReq": { - "description": "Model for Signin Request", - "examples": [ - { - "email": "user@example.com", - "password": "string" - } - ], - "properties": { - "email": { - "description": "Email address of the user", - "format": "email", - "type": "string" - }, - "password": { - "description": "Password of the user", - "type": "string" - } - }, - "required": ["email", "password"], - "title": "Signin Request Model", - "type": "object", - "x-stoplight": { - "id": "dxxafjky40cz1" - } - }, - "SignUpReq": { - "description": "Model for Signup Request", - "examples": [ - { - "email": "user@example.com", - "password": "password123456789", - "firstname": "Alice", - "lastname": "Smith", - "token": null, - "ignore_subscribe": 0 - } - ], - "title": "Signup Request Model", - "type": "object", - "properties": { - "email": { - "description": "Email address of the user", - "example": "user@example.com", - "format": "email", - "type": "string" - }, - "password": { - "description": "Password of the user", - "example": "password123456789", - "minLength": 8, - "type": "string" - }, - "firstname": { - "$ref": "#/components/schemas/StringOrNull", - "x-stoplight": { - "id": "lblivgs8wcsm1" - } - }, - "lastname": { - "$ref": "#/components/schemas/StringOrNull", - "x-stoplight": { - "id": "d4341r35tucq3" - } - }, - "token": { - "$ref": "#/components/schemas/StringOrNull", - "x-stoplight": { - "id": "otw9jgnr9n7c4" - }, - "description": "Sign Up Token. Used for invitation." - }, - "ignore_subscribe": { - "$ref": "#/components/schemas/Bool", - "x-stoplight": { - "id": "g7ge6mc6vdsds" - }, - "description": "Ignore Subscription" - } - }, - "required": ["email", "password"], - "x-stoplight": { - "id": "2rcbk0flkc4yu" - } - }, - "Sort": { - "description": "Model for Sort", - "examples": [ - { - "id": "so_xd4t51uv60ghzl", - "fk_column_id": "cl_l11b769pe2j1ce", - "fk_model_id": "md_ehn5izr99m7d45", - "base_id": "ds_3l9qx8xqksenrl", - "direction": "desc", - "order": 1, - "project_id": "p_9sx43moxhqtjm3" - } - ], - "title": "Sort Model", - "type": "object", - "properties": { - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "fk_column_id": { - "$ref": "#/components/schemas/Id" - }, - "fk_model_id": { - "$ref": "#/components/schemas/Id" - }, - "base_id": { - "type": "string", - "description": "Base ID", - "example": "ds_3l9qx8xqksenrl", - "readOnly": true - }, - "direction": { - "type": "string", - "description": "Sort direction", - "enum": ["asc", "desc"], - "example": "desc" - }, - "order": { - "type": "number", - "example": 1 - }, - "project_id": { - "type": "string", - "description": "Project ID", - "example": "p_9sx43moxhqtjm3", - "readOnly": true - } - }, - "x-stoplight": { - "id": "3jjbe2mjzy5li" - } - }, - "SortList": { - "description": "Model for Sort List", - "examples": [ - { - "list": [ - { - "id": "so_xd4t51uv60ghzl", - "fk_column_id": "cl_l11b769pe2j1ce", - "fk_model_id": "md_ehn5izr99m7d45", - "base_id": "ds_3l9qx8xqksenrl", - "direction": "desc", - "order": 1, - "project_id": "p_9sx43moxhqtjm3" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - ], - "title": "Sort List Model", - "type": "object", - "x-examples": { - "example-1": { - "bases": { - "list": [ - { - "alias": "string", - "database": "string", - "host": "string", - "id": "string", - "params": "string", - "password": "string", - "port": 0, - "project_id": "string", - "ssl": "string", - "type": "string", - "url": "string", - "username": "string" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "pageSize": 0, - "sort": "string", - "totalRows": 0 - } - } - } - }, - "properties": { - "list": { - "type": "array", - "x-stoplight": { - "id": "gjqqc8ciqg947" - }, - "description": "List of Sort Objects", - "items": { - "$ref": "#/components/schemas/Sort", - "x-stoplight": { - "id": "usnfa1kbovpmb" - } - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated", - "x-stoplight": { - "id": "i75wcejfp5mnq" - } - } - }, - "required": ["list", "pageInfo"], - "x-stoplight": { - "id": "fsq6d3pi8b3iz" - } - }, - "SortReq": { - "description": "Model for Sort Request", - "examples": [ - { - "direction": "asc", - "fk_column_id": "cl_l11b769pe2j1ce" - } - ], - "minProperties": 1, - "title": "Sort Request Model", - "type": "object", - "properties": { - "fk_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Column" - }, - "direction": { - "description": "Sort direction", - "enum": ["asc", "desc"], - "type": "string" - } - }, - "x-stoplight": { - "id": "lao7jfow2dbe7" - } - }, - "StringOrNull": { - "description": "Model for StringOrNull", - "examples": ["string"], - "oneOf": [ - { - "maxLength": 255, - "type": "string" - }, - { - "type": "null" - } - ], - "title": "StringOrNull Model", - "x-stoplight": { - "id": "xh9dwrizrvfh6" - } - }, - "Table": { - "description": "Model for Table", - "examples": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "columns": [ - { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": "CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP", - "clen": null, - "column_name": "updated_at", - "cop": "4", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "timestamp", - "deleted": null, - "dt": "timestamp", - "dtx": "specificType", - "dtxp": "0", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_m4wkaqgqqjzoeh", - "meta": null, - "np": null, - "ns": null, - "order": 4, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 0, - "system": 0, - "title": "UpdatedAt", - "uidt": "DateTime", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": "CURRENT_TIMESTAMP", - "clen": null, - "column_name": "created_at", - "cop": "3", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "timestamp", - "deleted": null, - "dt": "timestamp", - "dtx": "specificType", - "dtxp": "0", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_jpl0qu4gj4rexq", - "meta": null, - "np": null, - "ns": null, - "order": 3, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 0, - "system": 0, - "title": "CreatedAt", - "uidt": "DateTime", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": null, - "clen": "45", - "column_name": "title", - "cop": "2", - "created_at": "2023-03-02 17:04:06", - "csn": "utf8mb4", - "ct": "varchar(45)", - "deleted": null, - "dt": "varchar", - "dtx": "specificType", - "dtxp": "45", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_c5knoi4xs4sfpt", - "meta": null, - "np": null, - "ns": null, - "order": 2, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": 1, - "rqd": 0, - "system": 0, - "title": "Title", - "uidt": "SingleLineText", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - { - "ai": 1, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": null, - "clen": null, - "column_name": "id", - "cop": "1", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "int unsigned", - "deleted": null, - "dt": "int", - "dtx": "specificType", - "dtxp": "", - "dtxs": "0", - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_phvuuwjrzcdo0g", - "meta": null, - "np": "10", - "ns": "0", - "order": 1, - "pk": 1, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 1, - "system": 0, - "title": "Id", - "uidt": "ID", - "un": 1, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - } - ], - "columnsById": { - "cl_c5knoi4xs4sfpt": { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": null, - "clen": "45", - "column_name": "title", - "cop": "2", - "created_at": "2023-03-02 17:04:06", - "csn": "utf8mb4", - "ct": "varchar(45)", - "deleted": null, - "dt": "varchar", - "dtx": "specificType", - "dtxp": "45", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_c5knoi4xs4sfpt", - "meta": null, - "np": null, - "ns": null, - "order": 2, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": 1, - "rqd": 0, - "system": 0, - "title": "Title", - "uidt": "SingleLineText", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - "cl_jpl0qu4gj4rexq": { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": "CURRENT_TIMESTAMP", - "clen": null, - "column_name": "created_at", - "cop": "3", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "timestamp", - "deleted": null, - "dt": "timestamp", - "dtx": "specificType", - "dtxp": "0", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_jpl0qu4gj4rexq", - "meta": null, - "np": null, - "ns": null, - "order": 3, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 0, - "system": 0, - "title": "CreatedAt", - "uidt": "DateTime", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - "cl_m4wkaqgqqjzoeh": { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": "CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP", - "clen": null, - "column_name": "updated_at", - "cop": "4", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "timestamp", - "deleted": null, - "dt": "timestamp", - "dtx": "specificType", - "dtxp": "0", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_m4wkaqgqqjzoeh", - "meta": null, - "np": null, - "ns": null, - "order": 4, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 0, - "system": 0, - "title": "UpdatedAt", - "uidt": "DateTime", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - "cl_phvuuwjrzcdo0g": { - "ai": 1, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": null, - "clen": null, - "column_name": "id", - "cop": "1", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "int unsigned", - "deleted": null, - "dt": "int", - "dtx": "specificType", - "dtxp": "", - "dtxs": "0", - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_phvuuwjrzcdo0g", - "meta": null, - "np": "10", - "ns": "0", - "order": 1, - "pk": 1, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 1, - "system": 0, - "title": "Id", - "uidt": "ID", - "un": 1, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - } - }, - "created_at": "2023-03-02 17:04:06", - "deleted": null, - "enabled": 1, - "id": "md_rsu68aqjsbyqtl", - "meta": null, - "mm": 0, - "order": 1, - "pinned": null, - "project_id": "p_xm3thidrblw4n7", - "schema": null, - "table_name": "nc_vm5q___Table1", - "tags": null, - "title": "Table1", - "type": "table", - "updated_at": "2023-03-02 17:04:08", - "views": [ - { - "_ptn": "Table1", - "_tn": "Table1", - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:04:06", - "disabled": { - "commenter": false, - "creator": false, - "editor": false, - "guest": false, - "owner": false, - "viewer": false - }, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "vw_p2jcatxz4mvcfw", - "is_default": 1, - "lock_type": "collaborative", - "meta": {}, - "order": 1, - "password": null, - "project_id": "p_xm3thidrblw4n7", - "ptn": "nc_vm5q___Table1", - "ptype": "table", - "show": 1, - "show_system_fields": null, - "table_meta": null, - "title": "Table1", - "tn": "Table1", - "type": 3, - "updated_at": "2023-03-02 17:04:06", - "uuid": null, - "view": { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:04:06", - "fk_view_id": "vw_p2jcatxz4mvcfw", - "meta": null, - "project_id": "p_xm3thidrblw4n7", - "row_height": null, - "updated_at": "2023-03-02 17:04:06", - "uuid": null - } - } - ] - } - ], - "title": "Table Model", - "type": "object", - "properties": { - "base_id": { - "description": "Unique Base ID", - "type": "string" - }, - "columns": { - "description": "The columns included in this table", - "type": "array", - "items": { - "$ref": "#/components/schemas/Column" - } - }, - "columnsById": { - "description": "Column Models grouped by IDs", - "type": "object" - }, - "deleted": { - "$ref": "#/components/schemas/Bool" - }, - "enabled": { - "$ref": "#/components/schemas/Bool", - "description": "Is this table enabled?" - }, - "id": { - "description": "Unique Table ID", - "type": "string" - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "description": "Meta Data" - }, - "mm": { - "$ref": "#/components/schemas/Bool", - "description": "Is this table used for M2M" - }, - "order": { - "description": "The order of the list of tables", - "type": "number" - }, - "pinned": { - "$ref": "#/components/schemas/Bool", - "description": "Currently not in use" - }, - "project_id": { - "description": "Unique Project ID", - "type": "string" - }, - "table_name": { - "description": "Table Name. Prefix will be added for XCDB projects.", - "type": "string" - }, - "tags": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Currently not in use" - }, - "title": { - "description": "Table Title", - "type": "string" - }, - "type": { - "description": "Table Type", - "type": "string" - } - }, - "required": ["table_name", "title"], - "x-stoplight": { - "id": "rvdu5okgpz1xk" - } - }, - "TableList": { - "description": "Model for Table List", - "examples": [ - { - "list": [ - { - "alias": "string", - "base_id": "string", - "column": [ - { - "alias": "string", - "auto_increment": true, - "auto_update_timestamp": true, - "base_id": "string", - "character_maximum_length": "string", - "character_set_name": "string", - "colOptions": { - "deleted": "string", - "dr": "string", - "fk_child_column_id": "string", - "fk_column_id": "string", - "fk_index_name": "string", - "fk_mm_child_column_id": "string", - "fk_mm_model_id": "string", - "fk_mm_parent_column_id": "string", - "fk_parent_column_id": "string", - "id": "string", - "order": "string", - "type": "string", - "ur": "string", - "virtual": true - }, - "column_comment": "string", - "column_default": "string", - "column_ordinal_position": "string", - "column_type": "string", - "data_type": "string", - "data_type_x": "string", - "data_type_x_precision": "string", - "data_type_x_scale": "string", - "deleted": true, - "fk_model_id": "string", - "id": "string", - "numeric_precision": "string", - "numeric_scale": "string", - "order": 0, - "primary_key": true, - "primary_value": true, - "rqd": "string", - "title": "string", - "ui_data_type": "string", - "un": "string", - "unique": true, - "visible": true - } - ], - "columnByIds": {}, - "deleted": true, - "enabled": true, - "id": "string", - "order": 0, - "parent_id": "string", - "pinned": true, - "project_id": "string", - "show_as": "string", - "tags": "string", - "title": "string", - "type": "string" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - ], - "title": "Table List Model", - "type": "object", - "x-examples": { - "example-1": { - "bases": { - "list": [ - { - "alias": "string", - "database": "string", - "host": "string", - "id": "string", - "params": "string", - "password": "string", - "port": 0, - "project_id": "string", - "ssl": "string", - "type": "string", - "url": "string", - "username": "string" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "pageSize": 0, - "sort": "string", - "totalRows": 0 - } - } - } - }, - "properties": { - "list": { - "minItems": 1, - "type": "array", - "uniqueItems": true, - "description": "List of table objects", - "items": { - "$ref": "#/components/schemas/Table" - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated", - "description": "Paginated Info" - } - }, - "required": ["list", "pageInfo"], - "x-stoplight": { - "id": "25z7dodhqs3lc" - } - }, - "TableReq": { - "description": "Model for Table Request", - "examples": [ - { - "columns": [ - { - "ai": false, - "altered": 1, - "cdf": "CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP", - "ck": false, - "clen": 45, - "column_name": "updated_at", - "ct": "varchar(45)", - "dt": "timestamp", - "dtx": "specificType", - "dtxp": "", - "dtxs": "", - "np": null, - "nrqd": true, - "ns": null, - "pk": false, - "rqd": false, - "title": "UpdatedAt", - "uicn": "", - "uidt": "DateTime", - "uip": "", - "un": false - }, - { - "ai": false, - "altered": 1, - "cdf": "CURRENT_TIMESTAMP", - "ck": false, - "clen": 45, - "column_name": "created_at", - "ct": "varchar(45)", - "dt": "timestamp", - "dtx": "specificType", - "dtxp": "", - "dtxs": "", - "np": null, - "nrqd": true, - "ns": null, - "pk": false, - "rqd": false, - "title": "CreatedAt", - "uicn": "", - "uidt": "DateTime", - "uip": "", - "un": false - }, - { - "ai": false, - "altered": 1, - "cdf": null, - "ck": false, - "clen": 45, - "column_name": "title", - "ct": "varchar(45)", - "dt": "varchar", - "dtx": "specificType", - "dtxp": "45", - "dtxs": "", - "np": null, - "nrqd": true, - "ns": null, - "pk": false, - "rqd": false, - "title": "Title", - "uicn": "", - "uidt": "SingleLineText", - "uip": "", - "un": false - }, - { - "ai": true, - "altered": 1, - "cdf": null, - "ck": false, - "clen": null, - "column_name": "id", - "ct": "int(11)", - "dt": "int", - "dtx": "integer", - "dtxp": "11", - "dtxs": "", - "np": 11, - "nrqd": false, - "ns": 0, - "pk": true, - "rqd": true, - "title": "Id", - "uicn": "", - "uidt": "ID", - "uip": "", - "un": true - } - ], - "table_name": "Sheet-1", - "title": "Sheet-1" - } - ], - "properties": { - "columns": { - "description": "The column models in this table", - "items": { - "$ref": "#/components/schemas/NormalColumnRequest" - }, - "type": "array" - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "description": "the meta data for this table" - }, - "order": { - "description": "The order of table list", - "example": 1, - "type": "number" - }, - "table_name": { - "description": "Table name", - "example": "my_table", - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "title": { - "description": "Table title", - "example": "My Table", - "maxLength": 255, - "minLength": 0, - "type": "string" - } - }, - "required": ["columns", "table_name"], - "title": "Table Request Model", - "type": "object", - "x-stoplight": { - "id": "kilqakhuuzstv" - } - }, - "User": { - "description": "Model for User", - "examples": [ - { - "email": "user@example.com", - "email_verified": true, - "firstname": "Alice", - "id": "us_8kugj628ebjngs", - "lastname": "Smith", - "roles": "org-level-viewer" - } - ], - "title": "User Model", - "type": "object", - "x-internal": false, - "properties": { - "email": { - "description": "The email of the user", - "example": "user@example.com", - "format": "email", - "type": "string" - }, - "email_verified": { - "description": "Set to true if the user's email has been verified.", - "type": "boolean" - }, - "firstname": { - "description": "The first name of the user", - "example": "Alice", - "type": "string" - }, - "id": { - "description": "Unique identifier for the given user.", - "example": "us_8kugj628ebjngs", - "type": "string" - }, - "lastname": { - "description": "The last name of the user", - "example": "Smith", - "type": "string" - }, - "roles": { - "description": "The roles of the user", - "example": "org-level-viewer", - "type": "string" - } - }, - "required": ["email", "email_verified", "firstname", "id", "lastname"], - "x-stoplight": { - "id": "nwug6wvbc5yrp" - } - }, - "UserInfo": { - "description": "Model for User Info", - "examples": [ - { - "email": "user@example.com", - "email_verified": true, - "firstname": "string", - "id": "string", - "lastname": "string", - "roles": null - } - ], - "properties": { - "email": { - "description": "User Email", - "format": "email", - "type": "string" - }, - "email_verified": { - "description": "Set to true if the user's email has been verified.", - "type": "boolean" - }, - "firstname": { - "description": "The firstname of the user", - "type": "string" - }, - "id": { - "description": "User ID", - "type": "string" - }, - "lastname": { - "description": "The lastname of the user", - "type": "string" - }, - "roles": { - "description": "The roles of the user" - } - }, - "title": "User Info Model", - "type": "object", - "x-stoplight": { - "id": "qravubcoxvr6x" - } - }, - "UserList": { - "description": "Model for User List", - "examples": [ - { - "list": [ - { - "email": "user@example.com", - "email_verified": true, - "firstname": "Alice", - "id": "us_8kugj628ebjngs", - "lastname": "Smith", - "roles": "org-level-viewer" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - ], - "title": "User List Model", - "type": "object", - "x-examples": { - "example-1": { - "bases": { - "list": [ - { - "alias": "string", - "database": "string", - "host": "string", - "id": "string", - "params": "string", - "password": "string", - "port": 0, - "project_id": "string", - "ssl": "string", - "type": "string", - "url": "string", - "username": "string" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "pageSize": 0, - "sort": "string", - "totalRows": 0 - } - } - } - }, - "properties": { - "list": { - "type": "array", - "x-stoplight": { - "id": "8o7v47q3e67ef" - }, - "description": "List of user objects", - "items": { - "$ref": "#/components/schemas/User", - "x-stoplight": { - "id": "kwqzxwea9r5er" - } - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated", - "x-stoplight": { - "id": "0d98n6sfxfvft" - }, - "description": "Paginated Info" - } - }, - "required": ["list", "pageInfo"], - "x-stoplight": { - "id": "11epslmm9jcga" - } - }, - "View": { - "description": "Model for View", - "examples": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:46:31", - "fk_model_id": "md_mhs9z4r2ak98x0", - "id": "vw_lg052cnc1c26kf", - "is_default": 1, - "lock_type": "collaborative", - "meta": {}, - "order": 1, - "password": null, - "project_id": "p_xm3thidrblw4n7", - "show": 1, - "show_system_fields": null, - "title": "Sheet-1", - "type": 3, - "updated_at": "2023-03-02 17:46:31", - "uuid": null, - "view": { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:46:31", - "fk_view_id": "vw_lg052cnc1c26kf", - "meta": null, - "project_id": "p_xm3thidrblw4n7", - "row_height": null, - "updated_at": "2023-03-02 17:46:31", - "uuid": null - } - } - ], - "title": "View Model", - "type": "object", - "properties": { - "base_id": { - "$ref": "#/components/schemas/Id", - "description": "Unique Base ID" - }, - "fk_model_id": { - "$ref": "#/components/schemas/Id", - "description": "Unique Model ID" - }, - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID for View" - }, - "lock_type": { - "description": "Lock Type of the view", - "enum": ["collaborative", "locked", "personal"], - "type": "string" - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "description": "Meta data for this view" - }, - "order": { - "description": "The rder of the list of views", - "type": "number" - }, - "password": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Password for protecting the view" - }, - "project_id": { - "$ref": "#/components/schemas/Id", - "description": "Unique Project ID" - }, - "show": { - "$ref": "#/components/schemas/Bool", - "description": "If this view is shown?" - }, - "show_system_fields": { - "$ref": "#/components/schemas/Bool", - "description": "Should show system fields in this view?" - }, - "is_default": { - "$ref": "#/components/schemas/Bool", - "description": "Is this view default view for the model?" - }, - "title": { - "description": "View Title", - "type": "string" - }, - "type": { - "description": "View Type", - "type": "number" - }, - "uuid": { - "$ref": "#/components/schemas/StringOrNull", - "description": "UUID of the view" - }, - "view": { - "anyOf": [ - { - "$ref": "#/components/schemas/Form" - }, - { - "$ref": "#/components/schemas/Gallery" - }, - { - "$ref": "#/components/schemas/Grid" - }, - { - "$ref": "#/components/schemas/Kanban" - }, - { - "$ref": "#/components/schemas/Map" - } - ], - "description": "Associated View Model" - } - }, - "required": ["fk_model_id", "show", "title", "type"], - "x-stoplight": { - "id": "pbahdgaroikdz" - } - }, - "ViewList": { - "description": "Model for View List", - "examples": [ - { - "list": [ - { - "alias": "string", - "column": [ - { - "alias": "string", - "auto_increment": true, - "auto_update_timestamp": true, - "base_id": "string", - "character_maximum_length": "string", - "character_set_name": "string", - "colOptions": { - "deleted": "string", - "dr": "string", - "fk_child_column_id": "string", - "fk_column_id": "string", - "fk_index_name": "string", - "fk_mm_child_column_id": "string", - "fk_mm_model_id": "string", - "fk_mm_parent_column_id": "string", - "fk_parent_column_id": "string", - "id": "string", - "order": "string", - "type": "string", - "ur": "string", - "virtual": true - }, - "column_comment": "string", - "column_default": "string", - "column_ordinal_position": "string", - "column_type": "string", - "data_type": "string", - "data_type_x": "string", - "data_type_x_precision": "string", - "data_type_x_scale": "string", - "deleted": true, - "fk_model_id": "string", - "id": "string", - "numeric_precision": "string", - "numeric_scale": "string", - "order": 0, - "primary_key": true, - "primary_value": true, - "rqd": "string", - "title": "string", - "ui_data_type": "string", - "un": "string", - "unique": true, - "visible": true - } - ], - "columnByIds": {}, - "deleted": true, - "enabled": true, - "fk_base_id": "string", - "fk_project_id": "string", - "id": "string", - "order": 0, - "parent_id": "string", - "pinned": true, - "show_as": "string", - "tags": "string", - "title": "string", - "type": "string" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - ], - "title": "View List Model", - "type": "object", - "x-examples": { - "example-1": { - "bases": { - "list": [ - { - "alias": "string", - "database": "string", - "host": "string", - "id": "string", - "params": "string", - "password": "string", - "port": 0, - "project_id": "string", - "ssl": "string", - "type": "string", - "url": "string", - "username": "string" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "pageSize": 0, - "sort": "string", - "totalRows": 0 - } - } - } - }, - "properties": { - "list": { - "type": "array", - "description": "List of view objects", - "items": { - "$ref": "#/components/schemas/View" - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated", - "description": "Paginated Info" - } - }, - "required": ["list", "pageInfo"], - "x-stoplight": { - "id": "5wwtppugkhbeh" - } - }, - "ViewCreateReq": { - "type": "object", - "x-stoplight": { - "id": "lksv99846uy60" - }, - "title": "ViewCreateReq", - "description": "Model for View Create Request", - "examples": [ - { - "title": "My Grid View", - "type": 3, - "copy_from_id": null, - "fk_grp_col_id": null, - "fk_geo_data_col_id": null - }, - { - "title": "My Gallery View", - "type": 2, - "copy_from_id": null, - "fk_grp_col_id": null, - "fk_geo_data_col_id": null - }, - { - "title": "My Form View", - "type": 1, - "copy_from_id": null, - "fk_grp_col_id": null, - "fk_geo_data_col_id": null - }, - { - "title": "My Kanban View", - "type": 4, - "copy_from_id": null, - "fk_grp_col_id": "cl_g0a89q9xdry3lu", - "fk_geo_data_col_id": null - }, - { - "title": "My Map View", - "type": 5, - "copy_from_id": null, - "fk_grp_col_id": null, - "fk_geo_data_col_id": "cl_uu1meolj00tlrq" - } - ], - "properties": { - "title": { - "type": "string", - "description": "View Title", - "example": "My View" - }, - "type": { - "type": "number", - "description": "View Type" - }, - "copy_from_id": { - "$ref": "#/components/schemas/StringOrNull", - "description": "ID of view to be copied from. Used in Copy View." - }, - "fk_grp_col_id": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Foreign Key to Grouping Column. Used in creating Kanban View." - }, - "fk_geo_data_col_id": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Foreign Key to Geo Data Column. Used in creating Map View." - } - }, - "required": ["title"] - }, - "ViewUpdateReq": { - "description": "Model for View Update Request", - "x-stoplight": { - "id": "1enlswadfc6p5" - }, - "examples": [ - { - "title": "Grid View 1", - "uuid": "e2457bbf-e29c-4fec-866e-fe3b01dba57f", - "password": "password123", - "lock_type": "collaborative", - "meta": "{\"allowCSVDownload\":true}", - "order": 1, - "show_system_fields": 0 - } - ], - "title": "View Update Request Model", - "type": "object", - "properties": { - "title": { - "maxLength": 255, - "type": "string", - "description": "View Title", - "example": "Grid View 1" - }, - "uuid": { - "maxLength": 255, - "type": "string", - "x-stoplight": { - "id": "vlhs7xs644u8l" - }, - "description": "View UUID. Used in Shared View.", - "example": "e2457bbf-e29c-4fec-866e-fe3b01dba57f" - }, - "password": { - "maxLength": 255, - "type": "string", - "x-stoplight": { - "id": "vlhs7xs644u8l" - }, - "description": "View Password. Used in Shared View.", - "example": "password123" - }, - "lock_type": { - "enum": ["collaborative", "locked", "personal"], - "type": "string", - "description": "Lock type of View.", - "example": "collaborative" - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "description": "Meta info used in View." - }, - "order": { - "type": "number", - "description": "The order of the list of views.", - "example": 1, - "minimum": 0 - }, - "show_system_fields": { - "$ref": "#/components/schemas/Bool", - "description": "Should this view show system fields?" - } - } - }, - "ViewColumnUpdateReq": { - "description": "Model for View Column Update Request", - "x-stoplight": { - "id": "ifzuv29axterb" - }, - "examples": [ - { - "show": 0, - "order": 1 - } - ], - "title": "View Column Update Request Model", - "type": "object", - "properties": { - "show": { - "$ref": "#/components/schemas/Bool", - "description": "View Title", - "x-stoplight": { - "id": "coxius73ejq5x" - } - }, - "order": { - "type": "number", - "description": "The order of the list of views.", - "example": 1, - "minimum": 0 - } - } - }, - "ViewColumnReq": { - "description": "Model for View Column Request", - "x-stoplight": { - "id": "z4bq84nyqkhd8" - }, - "examples": [ - { - "fk_column_id": "cl_5jestblzneb649", - "show": 0, - "order": 1 - } - ], - "title": "View Column Request Model", - "type": "object", - "properties": { - "fk_column_id": { - "$ref": "#/components/schemas/Id", - "x-stoplight": { - "id": "rxd07wvp9hf6s" - }, - "description": "Foreign Key to Column" - }, - "show": { - "$ref": "#/components/schemas/Bool", - "description": "View Title", - "x-stoplight": { - "id": "coxius73ejq5x" - } - }, - "order": { - "type": "number", - "description": "The order of the list of views.", - "example": 1, - "minimum": 0 - } - } - }, - "VisibilityRuleReq": { - "description": "Model for Visibility Rule Request", - "examples": [ - [ - { - "disabled": { - "commenter": true, - "creator": true, - "editor": true, - "guest": true, - "owner": true, - "viewer": true - } - } - ] - ], - "items": { - "properties": { - "id": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "disabled": { - "properties": { - "commenter": { - "$ref": "#/components/schemas/Bool" - }, - "creator": { - "$ref": "#/components/schemas/Bool" - }, - "editor": { - "$ref": "#/components/schemas/Bool" - }, - "guest": { - "$ref": "#/components/schemas/Bool" - }, - "owner": { - "$ref": "#/components/schemas/Bool" - }, - "viewer": { - "$ref": "#/components/schemas/Bool" - } - }, - "type": "object" - } - }, - "type": "object" - }, - "title": "Visibility Rule Request Model", - "type": "array", - "x-stoplight": { - "id": "vuo5q4vwtarx8" - } - } - }, - "responses": { - "ProjectList": { - "description": "Example response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProjectList" - }, - "examples": { - "example-1": { - "value": { - "list": [ - { - "bases": [ - { - "alias": "string", - "config": null, - "created_at": "2023-03-01 14:27:36", - "enabled": true, - "id": "string", - "inflection_column": "camelize", - "inflection_table": "camelize", - "is_meta": true, - "order": 1, - "project_id": "string", - "type": "mysql2", - "updated_at": "2023-03-01 14:27:36" - } - ], - "color": "#24716E", - "created_at": "2023-03-01 14:27:36", - "deleted": true, - "description": "This is my project description", - "id": "p_124hhlkbeasewh", - "is_meta": true, - "meta": {}, - "order": 0, - "prefix": "nc_vm5q__", - "status": "string", - "title": "my-project", - "updated_at": "2023-03-01 14:27:36" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "BaseList": { - "description": "Example response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BaseList" - }, - "examples": { - "example-1": { - "value": { - "list": [ - { - "id": "ds_krsappzu9f8vmo", - "project_id": "p_01clqvzik3izk6", - "alias": null, - "config": "", - "meta": null, - "is_meta": 1, - "type": "mysql2", - "inflection_column": "camelize", - "inflection_table": "camelize", - "created_at": "2023-03-01 16:31:49", - "updated_at": "2023-03-02 11:28:17", - "enabled": 1, - "order": 1 - }, - { - "id": "ds_btbdt19zde0gj9", - "project_id": "p_01clqvzik3izk6", - "alias": "sakila", - "config": "", - "meta": null, - "is_meta": null, - "type": "mysql2", - "inflection_column": "camelize", - "inflection_table": "camelize", - "created_at": "2023-03-02 11:28:17", - "updated_at": "2023-03-02 11:28:17", - "enabled": 1, - "order": 2 - } - ], - "pageInfo": { - "totalRows": 2, - "page": 1, - "pageSize": 2, - "isFirstPage": true, - "isLastPage": true - } - } - } - } - } - } - }, - "TableList": { - "description": "Example response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TableList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "id": "md_5hua2iqloqirhd", - "base_id": "ds_jxuewivwbxeum2", - "project_id": "p_tbhl1hnycvhe5l", - "table_name": "nc_b84e___Sheet-1", - "title": "Sheet-1", - "type": "table", - "meta": null, - "schema": null, - "enabled": true, - "mm": false, - "tags": null, - "pinned": null, - "deleted": null, - "order": 1, - "created_at": "2023-03-11T09:11:45.907Z", - "updated_at": "2023-03-11T09:11:45.907Z" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "ColumnList": { - "description": "Example response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ColumnList" - } - } - } - }, - "FilterList": { - "description": "Example response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FilterList" - } - } - } - }, - "SortList": { - "description": "Example response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SortList" - }, - "examples": {} - } - } - }, - "ViewList": { - "description": "Example response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ViewList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "alias": "string", - "column": [ - { - "alias": "string", - "auto_increment": true, - "auto_update_timestamp": true, - "base_id": "string", - "character_maximum_length": "string", - "character_set_name": "string", - "colOptions": { - "deleted": "string", - "dr": "string", - "fk_child_column_id": "string", - "fk_column_id": "string", - "fk_index_name": "string", - "fk_mm_child_column_id": "string", - "fk_mm_model_id": "string", - "fk_mm_parent_column_id": "string", - "fk_parent_column_id": "string", - "id": "string", - "order": "string", - "type": "string", - "ur": "string", - "virtual": true - }, - "column_comment": "string", - "column_default": "string", - "column_ordinal_position": "string", - "column_type": "string", - "data_type": "string", - "data_type_x": "string", - "data_type_x_precision": "string", - "data_type_x_scale": "string", - "deleted": true, - "fk_model_id": "string", - "id": "string", - "numeric_precision": "string", - "numeric_scale": "string", - "order": 0, - "primary_key": true, - "primary_value": true, - "rqd": "string", - "title": "string", - "ui_data_type": "string", - "un": "string", - "unique": true, - "visible": true - } - ], - "columnByIds": {}, - "deleted": true, - "enabled": true, - "fk_base_id": "string", - "fk_project_id": "string", - "id": "string", - "order": 0, - "parent_id": "string", - "pinned": true, - "show_as": "string", - "tags": "string", - "title": "string", - "type": "string" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "SharedViewList": { - "description": "Example response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SharedViewList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:46:31", - "fk_model_id": "md_mhs9z4r2ak98x0", - "id": "vw_lg052cnc1c26kf", - "is_default": 1, - "lock_type": "collaborative", - "meta": {}, - "order": 1, - "password": null, - "project_id": "p_xm3thidrblw4n7", - "show": 1, - "show_system_fields": null, - "title": "Sheet-1", - "type": 3, - "updated_at": "2023-03-02 17:46:31", - "uuid": null, - "view": { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:46:31", - "fk_view_id": "vw_lg052cnc1c26kf", - "meta": null, - "project_id": "p_xm3thidrblw4n7", - "row_height": null, - "updated_at": "2023-03-02 17:46:31", - "uuid": null - } - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "HookList": { - "description": "Example response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HookList" - } - } - } - }, - "UserList": { - "description": "Example response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UserList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "email": "user@example.com", - "email_verified": true, - "firstname": "Alice", - "id": "us_8kugj628ebjngs", - "lastname": "Smith", - "roles": "org-level-viewer" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "APITokenList": { - "description": "Example response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiTokenList" - }, - "examples": {} - } - }, - "type": "object", - "properties": { - "list": { - "type": "array", - "x-stoplight": { - "id": "uukp6v55zfp7i" - }, - "items": { - "$ref": "#/components/schemas/ApiToken", - "x-stoplight": { - "id": "9zqpoqfkdxy0y" - } - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated", - "x-stoplight": { - "id": "6unr17jyisial" - } - } - } - }, - "BadRequest": { - "description": "BadReqeust", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "p9mk4oi0hbihm" - }, - "example": "BadRequest [Error]: " - } - }, - "required": ["msg"] - }, - "examples": { - "Example 1": { - "value": { - "msg": "BadRequest [Error]: " - } - } - } - } - }, - "headers": {} - } - }, - "securitySchemes": { - "xc-auth": { - "name": "Auth Token ", - "type": "apiKey", - "in": "header", - "description": "Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable `NC_JWT_EXPIRES_IN`." - }, - "xc-shared-base-id": { - "name": "Shared Base ID", - "type": "apiKey", - "in": "header", - "description": "Shared base uuid" - } - }, - "parameters": { - "xc-auth": { - "name": "xc-auth", - "in": "header", - "required": false, - "schema": { - "type": "string" - }, - "description": "Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN." - } - } - } -}{ - "openapi": "3.1.0", - "info": { - "title": "nocodb", - "version": "1.0", - "description": "NocoDB API Documentation" - }, - "x-tagGroups": [ - { - "name": "Auth APIs", - "tags": ["Auth", "API Token"] - }, - { - "name": "Public APIs", - "tags": ["Public"] - }, - { - "name": "Data APIs", - "tags": ["DB Table Row", "DB View Row", "Storage"] - }, - { - "name": "Meta APIs", - "tags": [ - "Base", - "DB Table", - "DB Table Column", - "DB Table Filter", - "DB Table Sort", - "DB Table Webhook", - "DB Table Webhook Filter", - "DB View", - "DB View Column", - "DB View Share", - "Plugin", - "Project", - "Utils" - ] - }, - { - "name": "Organisation APIs", - "tags": ["Org App Settings", "Org License", "Org Tokens", "Org Users"] - } - ], - "servers": [ - { - "url": "http://localhost:8080" - } - ], - "paths": { - "/api/v1/auth/user/signup": { - "post": { - "summary": "Signup", - "operationId": "auth-signup", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "token": { - "type": "string", - "description": "The signed JWT token for information exchange", - "example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbWFpbCI6IndAbm9jb2RiLmNvbSIsImZpcnN0bmFtZSI6bnVsbCwibGFzdG5hbWUiOm51bGwsImlkIjoidXNfYjN4bzJpNDRueDV5OWwiLCJyb2xlcyI6Im9yZy1sZXZlbC1jcmVhdG9yLHN1cGVyIiwidG9rZW5fdmVyc2lvbiI6ImJmMTc3ZGUzYjk3YjAzMjY4YjU0NGZmMjMzNGU5YjFhMGUzYzgxM2NiYzliOTJkYWMwYmM5NTRiNmUzN2ZjMTJjYmFkNDM2NmIwYzExZTdjIiwiaWF0IjoxNjc4MDc4NDMyLCJleHAiOjE2NzgxMTQ0MzJ9.gzwp_svZlbA5PV_eawYV-9UFjZVjniy-tCDce16xrkI" - } - } - }, - "examples": { - "Example 1": { - "value": { - "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbWFpbCI6IndAbm9jb2RiLmNvbSIsImZpcnN0bmFtZSI6bnVsbCwibGFzdG5hbWUiOm51bGwsImlkIjoidXNfYjN4bzJpNDRueDV5OWwiLCJyb2xlcyI6Im9yZy1sZXZlbC1jcmVhdG9yLHN1cGVyIiwidG9rZW5fdmVyc2lvbiI6ImJmMTc3ZGUzYjk3YjAzMjY4YjU0NGZmMjMzNGU5YjFhMGUzYzgxM2NiYzliOTJkYWMwYmM5NTRiNmUzN2ZjMTJjYmFkNDM2NmIwYzExZTdjIiwiaWF0IjoxNjc4MDc4NDMyLCJleHAiOjE2NzgxMTQ0MzJ9.gzwp_svZlbA5PV_eawYV-9UFjZVjniy-tCDce16xrkI" - } - } - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string" - } - } - }, - "examples": { - "Invalid email": { - "value": { - "msg": "Invalid email" - } - }, - "Invalid invite url": { - "value": { - "msg": "Invalid invite url" - } - }, - "Expired invite url": { - "value": { - "msg": "Expired invite url, Please contact super admin to get a new invite url" - } - }, - "User already exist": { - "value": { - "msg": "User already exist" - } - }, - "Invite only signup": { - "value": { - "msg": "Not allowed to signup, contact super admin" - } - } - } - } - } - } - }, - "tags": ["Auth"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SignUpReq" - }, - "examples": { - "Example 1": { - "value": { - "email": "user@example.com", - "password": "password123456789", - "firstname": "Alice", - "lastname": "Smith", - "token": null, - "ignore_subscribe": 0 - } - } - } - } - } - }, - "description": "Create a new user with provided email and password and first user is marked as super admin. " - } - }, - "/api/v1/auth/user/signout": { - "post": { - "summary": "Signout", - "operationId": "auth-signout", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "description": "Success Message", - "example": "Signed out successfully" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "Signed out successfully" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Auth"], - "description": "Clear refresh token from the database and cookie." - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "/api/v1/auth/user/signin": { - "post": { - "summary": "Signin", - "operationId": "auth-signin", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "token": { - "type": "string", - "description": "The signed JWT token for information exchange", - "example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbWFpbCI6IndAbm9jb2RiLmNvbSIsImZpcnN0bmFtZSI6bnVsbCwibGFzdG5hbWUiOm51bGwsImlkIjoidXNfYjN4bzJpNDRueDV5OWwiLCJyb2xlcyI6Im9yZy1sZXZlbC1jcmVhdG9yLHN1cGVyIiwidG9rZW5fdmVyc2lvbiI6ImJmMTc3ZGUzYjk3YjAzMjY4YjU0NGZmMjMzNGU5YjFhMGUzYzgxM2NiYzliOTJkYWMwYmM5NTRiNmUzN2ZjMTJjYmFkNDM2NmIwYzExZTdjIiwiaWF0IjoxNjc4MDc4NDMyLCJleHAiOjE2NzgxMTQ0MzJ9.gzwp_svZlbA5PV_eawYV-9UFjZVjniy-tCDce16xrkI" - } - } - }, - "examples": { - "Example 1": { - "value": { - "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbWFpbCI6IndAbm9jb2RiLmNvbSIsImZpcnN0bmFtZSI6bnVsbCwibGFzdG5hbWUiOm51bGwsImlkIjoidXNfYjN4bzJpNDRueDV5OWwiLCJyb2xlcyI6Im9yZy1sZXZlbC1jcmVhdG9yLHN1cGVyIiwidG9rZW5fdmVyc2lvbiI6ImJmMTc3ZGUzYjk3YjAzMjY4YjU0NGZmMjMzNGU5YjFhMGUzYzgxM2NiYzliOTJkYWMwYmM5NTRiNmUzN2ZjMTJjYmFkNDM2NmIwYzExZTdjIiwiaWF0IjoxNjc4MDc4NDMyLCJleHAiOjE2NzgxMTQ0MzJ9.gzwp_svZlbA5PV_eawYV-9UFjZVjniy-tCDce16xrkI" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Auth"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SignInReq" - }, - "examples": { - "example-1": { - "value": { - "email": "user@example.com", - "password": "Password" - } - } - } - } - } - }, - "description": "Authenticate existing user with their email and password. Successful login will return a JWT access-token. " - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "/api/v1/auth/user/me": { - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "get": { - "summary": "Get User Info", - "operationId": "auth-me", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UserInfo" - }, - "examples": { - "example-1": { - "value": { - "id": "us_8kugj628ebjngs", - "email": "user@example.com", - "email_verified": true, - "firstname": "Alice", - "lastname": "Smith", - "roles": "org-level-viewer" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Auth"], - "description": "Returns authenticated user info", - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id" - }, - "in": "query", - "name": "project_id", - "description": "Pass project id to get project specific roles along with user info" - } - ] - } - }, - "/api/v1/auth/password/forgot": { - "post": { - "summary": "Forget Password", - "operationId": "auth-password-forgot", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "q9s5vh2i34x6c" - }, - "example": "Please check your email to reset the password", - "description": "Success Message" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "Please check your email to reset the password" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Emails user with a reset url.", - "tags": ["Auth"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PasswordForgotReq" - }, - "examples": { - "Example 1": { - "value": { - "email": "user@example.com" - } - } - } - } - }, - "description": "Pass registered user email id in request body" - } - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "/api/v1/auth/password/change": { - "post": { - "summary": "Change Password", - "operationId": "auth-password-change", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "description": "Success Message" - } - } - }, - "examples": { - "Success response": { - "value": { - "msg": "Password has been updated successfully" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Change password of authenticated user with a new one.", - "tags": ["Auth"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PasswordChangeReq" - }, - "examples": { - "example-1": { - "value": { - "currentPassword": "currentPassword", - "newPassword": "newPassword" - } - } - } - } - }, - "description": "Old password need to be passed along with new password for changing password." - } - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "/api/v1/auth/token/validate/{token}": { - "post": { - "summary": "Verify Reset Token", - "operationId": "auth-password-reset-token-validate", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "unxdsok22kg1y" - }, - "example": "Token has been validated successfully", - "description": "Success Message" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "Token has been validated successfully" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Validate password reset url token.", - "tags": ["Auth"], - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "parameters": [ - { - "schema": { - "type": "string", - "format": "uuid", - "example": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11" - }, - "name": "token", - "in": "path", - "required": true, - "description": "Reset Token" - } - ] - }, - "/api/v1/auth/email/validate/{token}": { - "post": { - "summary": "Verify Email", - "operationId": "auth-email-validate", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "u49sbr20s9rgf" - }, - "description": "Success Message", - "example": "Email has been verified successfully" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "Email has been verified successfully" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Api for verifying email where token need to be passed which is shared to user email.", - "tags": ["Auth"], - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "parameters": [ - { - "schema": { - "type": "string", - "format": "uuid", - "example": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11" - }, - "name": "token", - "in": "path", - "required": true, - "description": "Validation Token" - } - ] - }, - "/api/v1/auth/password/reset/{token}": { - "post": { - "summary": "Reset Password", - "operationId": "auth-password-reset", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "2to6ro4121rfx" - }, - "description": "Success Message", - "example": "Password has been reset successfully" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "Password has been reset successfully" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Update user password to new by using reset token.", - "tags": ["Auth"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PasswordResetReq" - }, - "examples": { - "Example 1": { - "value": { - "password": "newpassword" - } - } - } - } - } - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "parameters": [ - { - "schema": { - "type": "string", - "format": "uuid", - "example": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11" - }, - "name": "token", - "in": "path", - "required": true, - "description": "Reset Password Token" - } - ] - }, - "/api/v1/auth/token/refresh": { - "post": { - "summary": "Refresh Token", - "operationId": "auth-token-refresh", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "token": { - "type": "string", - "description": "New access token for user", - "example": "96751db2d53fb834382b682268874a2ea9ee610e4d904e688d1513f11d3c30d62d36d9e05dec0d63" - } - } - }, - "examples": { - "Example 1": { - "value": { - "token": "96751db2d53fb834382b682268874a2ea9ee610e4d904e688d1513f11d3c30d62d36d9e05dec0d63" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Regenerate user refresh token", - "tags": ["Auth"], - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "/api/v1/tokens": { - "get": { - "summary": "List Organisation API Tokens", - "operationId": "org-tokens-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiTokenList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "id": "1", - "fk_user_id": "us_b3xo2i44nx5y9l", - "description": "This API Token is for ABC application", - "token": "DYh540o8hbWpUGdarekECKLdN5OhlgCUWutVJYX2" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "List all organisation API tokens. Access with API tokens will be blocked.", - "tags": ["Org Tokens"], - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "post": { - "summary": "Create Organisation API Token", - "operationId": "org-tokens-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiToken" - }, - "examples": { - "Example 1": { - "value": { - "id": "1", - "fk_user_id": "us_b3xo2i44nx5y9l", - "description": "This API Token is for ABC application", - "token": "DYh540o8hbWpUGdarekECKLdN5OhlgCUWutVJYX2" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiTokenReq" - }, - "examples": { - "Example 1": { - "value": { - "description": "This API token is for ABC application" - } - } - } - } - } - }, - "tags": ["Org Tokens"], - "description": "Creat an organisation API token. Access with API tokens will be blocked." - } - }, - "/api/v1/tokens/{token}": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "token", - "in": "path", - "required": true, - "description": "API Token" - } - ], - "delete": { - "summary": "Delete Organisation API Tokens", - "operationId": "org-tokens-delete", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number", - "example": 1 - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Org Tokens"], - "description": "Delete an organisation API token. Access with API tokens will be blocked.", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/license": { - "get": { - "summary": "Get App License", - "operationId": "org-license-get", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Application license key" - } - } - }, - "examples": { - "Example 1": { - "value": { - "key": "195f7bcc-c3e1-43c5-b23c-8d8127280e7d" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Get the application license key. Exclusive for super admin.", - "tags": ["Org License"], - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "post": { - "summary": "Create App License", - "operationId": "org-license-set", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "wsiywigeb9hjl" - }, - "example": "The license key has been saved" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "The license key has been saved" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/LicenseReq" - }, - "examples": { - "Example 1": { - "value": { - "key": "1234567890" - } - } - } - } - } - }, - "tags": ["Org License"], - "description": "Set the application license key. Exclusive for super admin.", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/app-settings": { - "get": { - "summary": "Get App Settings", - "operationId": "org-app-settings-get", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "invite_only_signup": { - "type": "boolean", - "description": "Status of invite only signup", - "example": true - } - } - }, - "examples": { - "Example 1": { - "value": { - "invite_only_signup": true - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Get the application settings. Exclusive for super admin.", - "tags": ["Org App Settings"], - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "post": { - "summary": "Create App Settings", - "operationId": "org-app-settings-set", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "6qbh8ijtc4tva" - }, - "example": "The app settings have been saved" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "The app settings have been saved" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "invite_only_signup": { - "type": "boolean", - "description": "Status of invite only signup", - "example": true - } - } - }, - "examples": { - "Example 1": { - "value": { - "invite_only_signup": true - } - } - } - } - } - }, - "tags": ["Org App Settings"], - "description": "Update the application settings. Exclusive for super admin.", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/users": { - "get": { - "summary": "List Organisation Users", - "operationId": "org-users-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UserList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "email": "user@example.com", - "email_verified": true, - "firstname": "Alice", - "id": "us_8kugj628ebjngs", - "lastname": "Smith", - "roles": "org-level-viewer" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "List all organisation users. Exclusive for Super Admin. Access with API Tokens will be blocked.", - "tags": ["Org Users"], - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "post": { - "summary": "Create Organisation User", - "operationId": "org-users-add", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "x-examples": { - "Example 1": { - "invite_token": "c22c129f-d947-4030-a838-1b498fce21bb", - "email": "w123@nocodb.com" - } - }, - "properties": { - "invite_token": { - "type": "string", - "description": "Invite Token" - }, - "email": { - "type": "string", - "description": "User email", - "example": "user@example.com" - } - } - }, - "examples": { - "Example 1": { - "value": { - "invite_token": "c22c129f-d947-4030-a838-1b498fce21bb", - "email": "user@example.com" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/OrgUserReq" - }, - "examples": { - "Example 1": { - "value": { - "email": "user@example.com", - "roles": "org-level-creator" - } - } - } - } - } - }, - "tags": ["Org Users"], - "description": "Create an organisation user. Exclusive for Super Admin. Access with API Tokens will be blocked.", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/users/{userId}": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "us_b3xo2i44nx5y9l" - }, - "name": "userId", - "in": "path", - "required": true, - "description": "Unique User ID" - } - ], - "patch": { - "summary": "Update Organisation User", - "operationId": "org-users-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "6oa45bkw7j57j" - }, - "example": "The user has been updated successfully" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "The user has been updated successfully" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Org Users"], - "description": "Update an organisation user by User ID. Exclusive for Super Admin. Access with API Tokens will be blocked.", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/OrgUserReq" - }, - "examples": { - "Example 1": { - "value": { - "email": "user@example.com", - "roles": "org-level-creator" - } - } - } - } - }, - "description": "" - } - }, - "delete": { - "summary": "Delete Organisation User", - "operationId": "org-users-delete", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "buvrqjvv255tf" - }, - "example": "The user has been deleted successfully", - "description": "Sucess Message" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "The user has been deleted successfully" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Org Users"], - "description": "Delete an organisation user by User ID. Exclusive for Super Admin. Access with API Tokens will be blocked." - } - }, - "/api/v1/users/{userId}/resend-invite": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "us_b3xo2i44nx5y9l" - }, - "name": "userId", - "in": "path", - "required": true, - "description": "Unique User ID" - } - ], - "post": { - "summary": "Invite Organisation User", - "operationId": "org-users-resend-invite", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "aixfqd9jfh5pq" - }, - "example": "The invitation has been sent to the target user", - "description": "Success Message" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "The invitation has been sent to the target user" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Org Users"], - "description": "Resend Invitation to a specific user. Exclusive for Super Admin. Access with API Tokens will be blocked.", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/users/{userId}/generate-reset-url": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "us_b3xo2i44nx5y9l" - }, - "name": "userId", - "in": "path", - "required": true, - "description": "Unique User ID" - } - ], - "post": { - "summary": "Generate Organisation User Password Reset Token", - "operationId": "org-users-generate-password-reset-token", - "tags": ["Org Users"], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "reset_password_token": { - "type": "string", - "description": "Password Reset Token for the user" - }, - "reset_password_url": { - "type": "string", - "description": "Password Reset URL for the user" - } - } - }, - "examples": { - "Example 1": { - "value": { - "reset_password_token": "string", - "reset_password_url": "string" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Generate Password Reset Token for Organisation User. Exclusive for Super Admin. Access with API Tokens will be blocked.", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/projects/{projectId}/users": { - "get": { - "summary": "List Project Users", - "operationId": "auth-project-user-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "users": { - "type": "object", - "properties": { - "list": { - "type": "array", - "uniqueItems": true, - "minItems": 1, - "items": { - "$ref": "#/components/schemas/User" - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated" - } - }, - "required": ["list", "pageInfo"] - } - } - }, - "examples": { - "Example 1": { - "value": { - "users": { - "list": [ - { - "email": "user@example.com", - "email_verified": true, - "firstname": "Alice", - "id": "us_8kugj628ebjngs", - "lastname": "Smith", - "roles": "org-level-viewer" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "List all users in the given project.", - "tags": ["Auth"], - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - } - ], - "post": { - "summary": "Create Project User", - "operationId": "auth-project-user-add", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "waau9tvy75zsd" - }, - "description": "Success Message for inviting single email", - "example": "The user has been invited successfully" - }, - "invite_token": { - "type": "string", - "x-stoplight": { - "id": "yx0s35u8ds3p7" - }, - "example": "8354ddba-a769-4d64-8397-eccb2e2b3c06" - }, - "error": { - "type": "array", - "x-stoplight": { - "id": "yhfi6wzhr6zr1" - }, - "items": { - "x-stoplight": { - "id": "ce0hlv3d0f96j" - }, - "type": "object", - "properties": { - "email": { - "type": "string", - "x-stoplight": { - "id": "dgnh01j4lxvl1" - }, - "example": "w@nocodb.com" - }, - "error": { - "type": "string", - "x-stoplight": { - "id": "7dgttqiijg8no" - }, - "example": "" - } - } - } - }, - "email": { - "type": "string", - "x-stoplight": { - "id": "08pqst2q30vot" - }, - "example": "w@nocodb.com" - } - } - }, - "examples": { - "Inviting a user without any errors": { - "value": { - "msg": "The user has been invited successfully" - } - }, - "Inviting a user but invitation email failed to send": { - "value": { - "invite_token": "8354ddba-a769-4d64-8397-eccb2e2b3c06", - "email": "w@nocodb.com" - } - }, - "Inviting multiple users": { - "value": { - "invite_token": "8354ddba-a769-4d64-8397-eccb2e2b3c06", - "error": [ - { - "email": "w@nocodb.com", - "error": "" - } - ] - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProjectUserReq" - }, - "examples": { - "Example 1": { - "value": { - "email": "user@example.com", - "roles": "owner" - } - } - } - } - } - }, - "tags": ["Auth"], - "description": "Create a user and add it to the given project", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/projects/{projectId}/info": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - } - ], - "get": { - "summary": "Get Project info", - "operationId": "project-meta-get", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "Node": { - "type": "string", - "description": "Node version", - "example": "v12.16.1" - }, - "Arch": { - "type": "string", - "description": "Architecture type", - "example": "x64" - }, - "Platform": { - "type": "string", - "description": "Platform type", - "example": "linux" - }, - "Docker": { - "type": "boolean", - "description": "Is docker", - "example": false - }, - "Database": { - "type": "string", - "description": "Database type", - "example": "postgres" - }, - "ProjectOnRootDB": { - "type": "boolean", - "description": "Is project on rootdb", - "example": false - }, - "RootDB": { - "type": "string", - "description": "Root database type", - "example": "postgres" - }, - "PackageVersion": { - "type": "string", - "description": "Package version", - "example": "1.0.0" - } - } - }, - "examples": { - "Example 1": { - "value": { - "Node": "v12.16.1", - "Arch": "x64", - "Platform": "linux", - "Docker": false, - "Database": "postgres", - "ProjectOnRootDB": false, - "RootDB": "postgres", - "PackageVersion": "1.0.0" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Project"], - "description": "Get info such as node version, arch, platform, is docker, rootdb and package version of a given project", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/projects/{projectId}/users/{userId}": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - }, - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "us_b3xo2i44nx5y9l" - }, - "name": "userId", - "in": "path", - "required": true, - "description": "Unique User ID" - } - ], - "patch": { - "summary": "Update Project User", - "operationId": "auth-project-user-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "5a2q8as60daly" - }, - "description": "Success Message", - "example": "The user has been updated successfully" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "The user has been updated successfully" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProjectUserReq" - }, - "examples": { - "Example 1": { - "value": { - "email": "user@example.com", - "roles": "owner" - } - } - } - } - } - }, - "tags": ["Auth"], - "description": "Update a given user in a given project. Exclusive for Super Admin. Access with API Tokens will be blocked.", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "delete": { - "summary": "Delete Project User", - "operationId": "auth-project-user-remove", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "5h7c9lqh5ynve" - }, - "example": "The user has been updated successfully", - "description": "Success Message" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "The user has been updated successfully" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Auth"], - "description": "Delete a given user in a given project. Exclusive for Super Admin. Access with API Tokens will be blocked.", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/projects/{projectId}/visibility-rules": { - "get": { - "summary": "Get UI ACL", - "operationId": "project-model-visibility-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": {} - }, - "examples": { - "Example 1": { - "value": [ - { - "ptn": "nc_09gt___Sheet-1", - "_ptn": "Sheet-1", - "ptype": "table", - "tn": "Sheet-1", - "_tn": "Sheet-1", - "table_meta": null, - "id": "vw_75neroyqdye94k", - "base_id": "ds_eol59jg2l4zwev", - "project_id": "p_63b4q0qengen1x", - "fk_model_id": "md_5mipbdg6ketmv8", - "title": "Sheet-1", - "type": 3, - "is_default": true, - "show_system_fields": null, - "lock_type": "collaborative", - "uuid": "24a6d0bb-e45d-4b1a-bfef-f492d870de9f", - "password": null, - "show": true, - "order": 1, - "created_at": "2023-03-08T10:44:55.253Z", - "updated_at": "2023-03-10T07:18:44.908Z", - "meta": { - "allowCSVDownload": true - }, - "view": { - "fk_view_id": "vw_75neroyqdye94k", - "base_id": "ds_eol59jg2l4zwev", - "project_id": "p_63b4q0qengen1x", - "uuid": null, - "created_at": "2023-03-08T10:44:55.288Z", - "updated_at": "2023-03-08T10:44:55.288Z", - "meta": null, - "row_height": null - }, - "disabled": { - "owner": false, - "creator": false, - "viewer": false, - "editor": false, - "commenter": false, - "guest": false - } - } - ] - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Hide / show views based on user role", - "tags": ["Project"], - "parameters": [ - { - "schema": { - "type": "boolean" - }, - "in": "query", - "name": "includeM2M" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - } - ], - "post": { - "summary": "Create UI ACL", - "operationId": "project-model-visibility-set", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "2txh071wsodys" - }, - "example": "UI ACL has been created successfully" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "UI ACL has been created successfully" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VisibilityRuleReq" - } - } - } - }, - "tags": ["Project"], - "description": "Hide / show views based on user role", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/projects/": { - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "get": { - "summary": "List Projects", - "operationId": "project-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProjectList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "bases": [ - { - "alias": "string", - "config": null, - "created_at": "2023-03-01 14:27:36", - "enabled": true, - "id": "string", - "inflection_column": "camelize", - "inflection_table": "camelize", - "is_meta": true, - "order": 1, - "project_id": "string", - "type": "mysql2", - "updated_at": "2023-03-01 14:27:36" - } - ], - "color": "#24716E", - "created_at": "2023-03-01 14:27:36", - "deleted": true, - "description": "This is my project description", - "id": "p_124hhlkbeasewh", - "is_meta": true, - "meta": {}, - "order": 0, - "prefix": "nc_vm5q__", - "status": "string", - "title": "my-project", - "updated_at": "2023-03-01 14:27:36" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "List all project meta data", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["Project"] - }, - "post": { - "summary": "Create Project", - "operationId": "project-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProjectReq" - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/Project" - }, - { - "type": "object", - "properties": { - "external": { - "type": "boolean", - "default": false, - "description": "If true, the project will us an external database else it will use the root database" - } - } - } - ] - }, - "examples": { - "Example 1": { - "value": { - "bases": [ - { - "alias": "string", - "config": null, - "enabled": true, - "id": "string", - "inflection_column": "camelize", - "inflection_table": "camelize", - "is_meta": true, - "order": 1, - "project_id": "string", - "type": "mysql2", - "updated_at": "2023-03-01 14:27:36" - } - ], - "color": "#24716E", - "created_at": "2023-03-01 14:27:36", - "deleted": true, - "description": "This is my project description", - "id": "p_124hhlkbeasewh", - "is_meta": true, - "meta": {}, - "order": 0, - "prefix": "nc_vm5q__", - "status": "string", - "title": "my-project", - "external": false - } - } - } - } - } - }, - "tags": ["Project"], - "description": "Create a new project", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/projects/{projectId}": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - } - ], - "get": { - "summary": "Get Project", - "operationId": "project-read", - "description": "Get the info of a given project", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["Project"], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Project" - }, - "examples": { - "Example 1": { - "value": { - "bases": [ - { - "alias": "string", - "config": null, - "enabled": true, - "id": "string", - "inflection_column": "camelize", - "inflection_table": "camelize", - "is_meta": true, - "order": 1, - "project_id": "string", - "type": "mysql2", - "updated_at": "2023-03-01 14:27:36" - } - ], - "color": "#24716E", - "created_at": "2023-03-01 14:27:36", - "deleted": true, - "description": "This is my project description", - "id": "p_124hhlkbeasewh", - "is_meta": true, - "meta": {}, - "order": 0, - "prefix": "nc_vm5q__", - "status": "string", - "title": "my-project" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - } - }, - "delete": { - "summary": "Delete Project", - "operationId": "project-delete", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "boolean" - }, - "examples": { - "Example 1": { - "value": true - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Project"], - "description": "Delete the given project", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "patch": { - "summary": "Update Project", - "operationId": "project-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number", - "example": 1 - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Project"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProjectUpdateReq" - }, - "examples": { - "Example 1": { - "value": { - "color": "#24716E", - "meta": null, - "title": "My Project" - } - } - } - } - } - }, - "description": "Update the given project", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/projects/{projectId}/bases/{baseId}": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - }, - { - "schema": { - "type": "string", - "pattern": "ds_j04jmxh5xg10lu" - }, - "name": "baseId", - "in": "path", - "required": true, - "description": "Unique Base ID" - } - ], - "get": { - "summary": "Get Base", - "operationId": "base-read", - "description": "Get the base details of a given project", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["Base"], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Base" - }, - "examples": { - "Example 1": { - "value": { - "alias": null, - "config": "", - "enabled": 1, - "id": "ds_krsappzu9f8vmo", - "inflection_column": "camelize", - "inflection_table": "camelize", - "is_meta": 1, - "meta": null, - "order": 1, - "project_id": "p_01clqvzik3izk6", - "type": "mysql2" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - } - }, - "delete": { - "summary": "Delete Base", - "operationId": "base-delete", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "boolean" - }, - "examples": { - "Example 1": { - "value": true - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Base"], - "description": "Delete the base details of a given project", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "patch": { - "summary": "Update Base", - "operationId": "base-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {} - }, - "examples": { - "Example 1": { - "value": { - "id": "ds_rrplkgy0pq1f3c", - "project_id": "p_63b4q0qengen1x", - "alias": "sakila", - "meta": null, - "is_meta": null, - "type": "mysql2", - "inflection_column": "camelize", - "inflection_table": "camelize", - "created_at": "2023-03-11T10:31:15.341Z", - "updated_at": "2023-03-11T10:32:25.763Z", - "enabled": true, - "order": 2 - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Base"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "examples": { - "Example 1": { - "value": { - "alias": "sakila", - "type": "mysql2", - "config": { - "client": "mysql2", - "connection": { - "host": "localhost", - "port": "3306", - "user": "root", - "password": "password", - "database": "sakila" - } - }, - "inflection_column": "camelize", - "inflection_table": "camelize" - } - } - } - } - } - }, - "description": "Update the base details of a given project", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/projects/{projectId}/bases/": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - } - ], - "get": { - "summary": "List Bases", - "operationId": "base-list", - "description": "Get project base list", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["Base"], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BaseList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "alias": null, - "config": "", - "enabled": 1, - "id": "ds_krsappzu9f8vmo", - "inflection_column": "camelize", - "inflection_table": "camelize", - "is_meta": 1, - "meta": null, - "order": 1, - "project_id": "p_01clqvzik3izk6", - "type": "mysql2" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - } - }, - "post": { - "summary": "Create Base", - "operationId": "base-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Base" - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/Base" - }, - { - "type": "object", - "properties": { - "external": { - "type": "boolean", - "default": false - } - } - } - ] - }, - "examples": { - "Example 1": { - "value": { - "alias": null, - "config": "", - "enabled": 1, - "id": "ds_krsappzu9f8vmo", - "inflection_column": "camelize", - "inflection_table": "camelize", - "is_meta": 1, - "meta": null, - "order": 1, - "project_id": "p_01clqvzik3izk6", - "type": "mysql2", - "external": false - } - } - } - } - } - }, - "tags": ["Base"], - "description": "Create a new base on a given project", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/projects/{projectId}/shared": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - } - ], - "get": { - "summary": "Get Project Shared Base", - "operationId": "project-shared-base-get", - "description": "Get Project Shared Base", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["Project"], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "uuid": { - "type": "string", - "format": "uuid", - "example": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11" - }, - "url": { - "type": "string", - "format": "uri" - }, - "roles": { - "type": "string", - "example": "viewer" - } - } - }, - "examples": { - "Example 1": { - "value": { - "uuid": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11", - "url": "http://example.com", - "roles": "viewer" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - } - }, - "delete": { - "summary": "Delete Project Shared Base", - "operationId": "project-shared-base-disable", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "boolean" - }, - "examples": { - "Example 1": { - "value": true - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Project"], - "description": "Delete Project Shared Base", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "post": { - "summary": "Create Project Shared Base", - "operationId": "project-shared-base-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "uuid": { - "$ref": "#/components/schemas/StringOrNull" - }, - "roles": { - "$ref": "#/components/schemas/StringOrNull" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Project"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SharedBaseReq" - }, - "examples": { - "Example 1": { - "value": { - "roles": "editor", - "password": "password123" - } - } - } - } - } - }, - "description": "Create Project Shared Base", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "patch": { - "summary": "Update Project Shared Base", - "operationId": "project-shared-base-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "uuid": { - "type": "string", - "format": "uuid", - "example": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11" - }, - "url": { - "type": "string", - "format": "uri" - }, - "roles": { - "type": "string", - "example": "viewer" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SharedBaseReq" - }, - "examples": { - "Example 1": { - "value": { - "password": "password123", - "roles": "editor" - } - } - } - } - } - }, - "tags": ["Project"], - "description": "Update Project Shared Base", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/projects/{projectId}/cost": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - } - ], - "get": { - "summary": "Project Cost", - "operationId": "project-cost", - "description": "Calculate the Project Cost", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["Project"], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {} - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "x-internal": true - } - }, - "/api/v1/db/meta/projects/{projectId}/tables": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - } - ], - "post": { - "summary": "Create Table", - "operationId": "db-table-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Table" - }, - "examples": { - "Example 1": { - "value": { - "base_id": "ds_g4ccx6e77h1dmi", - "columns": [ - { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": "CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP", - "clen": null, - "column_name": "updated_at", - "cop": "4", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "timestamp", - "deleted": null, - "dt": "timestamp", - "dtx": "specificType", - "dtxp": "0", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_m4wkaqgqqjzoeh", - "meta": null, - "np": null, - "ns": null, - "order": 4, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 0, - "system": 0, - "title": "UpdatedAt", - "uidt": "DateTime", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": "CURRENT_TIMESTAMP", - "clen": null, - "column_name": "created_at", - "cop": "3", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "timestamp", - "deleted": null, - "dt": "timestamp", - "dtx": "specificType", - "dtxp": "0", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_jpl0qu4gj4rexq", - "meta": null, - "np": null, - "ns": null, - "order": 3, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 0, - "system": 0, - "title": "CreatedAt", - "uidt": "DateTime", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": null, - "clen": "45", - "column_name": "title", - "cop": "2", - "created_at": "2023-03-02 17:04:06", - "csn": "utf8mb4", - "ct": "varchar(45)", - "deleted": null, - "dt": "varchar", - "dtx": "specificType", - "dtxp": "45", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_c5knoi4xs4sfpt", - "meta": null, - "np": null, - "ns": null, - "order": 2, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": 1, - "rqd": 0, - "system": 0, - "title": "Title", - "uidt": "SingleLineText", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - { - "ai": 1, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": null, - "clen": null, - "column_name": "id", - "cop": "1", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "int unsigned", - "deleted": null, - "dt": "int", - "dtx": "specificType", - "dtxp": "", - "dtxs": "0", - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_phvuuwjrzcdo0g", - "meta": null, - "np": "10", - "ns": "0", - "order": 1, - "pk": 1, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 1, - "system": 0, - "title": "Id", - "uidt": "ID", - "un": 1, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - } - ], - "columnsById": { - "cl_c5knoi4xs4sfpt": { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": null, - "clen": "45", - "column_name": "title", - "cop": "2", - "created_at": "2023-03-02 17:04:06", - "csn": "utf8mb4", - "ct": "varchar(45)", - "deleted": null, - "dt": "varchar", - "dtx": "specificType", - "dtxp": "45", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_c5knoi4xs4sfpt", - "meta": null, - "np": null, - "ns": null, - "order": 2, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": 1, - "rqd": 0, - "system": 0, - "title": "Title", - "uidt": "SingleLineText", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - "cl_jpl0qu4gj4rexq": { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": "CURRENT_TIMESTAMP", - "clen": null, - "column_name": "created_at", - "cop": "3", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "timestamp", - "deleted": null, - "dt": "timestamp", - "dtx": "specificType", - "dtxp": "0", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_jpl0qu4gj4rexq", - "meta": null, - "np": null, - "ns": null, - "order": 3, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 0, - "system": 0, - "title": "CreatedAt", - "uidt": "DateTime", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - "cl_m4wkaqgqqjzoeh": { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": "CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP", - "clen": null, - "column_name": "updated_at", - "cop": "4", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "timestamp", - "deleted": null, - "dt": "timestamp", - "dtx": "specificType", - "dtxp": "0", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_m4wkaqgqqjzoeh", - "meta": null, - "np": null, - "ns": null, - "order": 4, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 0, - "system": 0, - "title": "UpdatedAt", - "uidt": "DateTime", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - "cl_phvuuwjrzcdo0g": { - "ai": 1, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": null, - "clen": null, - "column_name": "id", - "cop": "1", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "int unsigned", - "deleted": null, - "dt": "int", - "dtx": "specificType", - "dtxp": "", - "dtxs": "0", - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_phvuuwjrzcdo0g", - "meta": null, - "np": "10", - "ns": "0", - "order": 1, - "pk": 1, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 1, - "system": 0, - "title": "Id", - "uidt": "ID", - "un": 1, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - } - }, - "created_at": "2023-03-02 17:04:06", - "deleted": null, - "enabled": 1, - "id": "md_rsu68aqjsbyqtl", - "meta": null, - "mm": 0, - "order": 1, - "pinned": null, - "project_id": "p_xm3thidrblw4n7", - "schema": null, - "table_name": "nc_vm5q___Table1", - "tags": null, - "title": "Table1", - "type": "table", - "updated_at": "2023-03-02 17:04:08", - "views": [ - { - "_ptn": "Table1", - "_tn": "Table1", - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:04:06", - "disabled": { - "commenter": false, - "creator": false, - "editor": false, - "guest": false, - "owner": false, - "viewer": false - }, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "vw_p2jcatxz4mvcfw", - "is_default": 1, - "lock_type": "collaborative", - "meta": {}, - "order": 1, - "password": null, - "project_id": "p_xm3thidrblw4n7", - "ptn": "nc_vm5q___Table1", - "ptype": "table", - "show": 1, - "show_system_fields": null, - "table_meta": null, - "title": "Table1", - "tn": "Table1", - "type": 3, - "updated_at": "2023-03-02 17:04:06", - "uuid": null, - "view": { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:04:06", - "fk_view_id": "vw_p2jcatxz4mvcfw", - "meta": null, - "project_id": "p_xm3thidrblw4n7", - "row_height": null, - "updated_at": "2023-03-02 17:04:06", - "uuid": null - } - } - ] - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TableReq" - } - } - } - }, - "tags": ["DB Table"], - "description": "Create a new table in a given project", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "get": { - "summary": "List Tables", - "operationId": "db-table-list", - "responses": { - "200": { - "$ref": "#/components/responses/TableList" - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - }, - { - "schema": { - "type": "number" - }, - "in": "query", - "name": "page" - }, - { - "schema": { - "type": "number" - }, - "in": "query", - "name": "pageSize" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "sort" - }, - { - "schema": { - "type": "boolean" - }, - "in": "query", - "name": "includeM2M" - } - ], - "tags": ["DB Table"], - "description": "List all tables in a given project" - } - }, - "/api/v1/db/meta/tables/{tableId}": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "md_w9gpnaousnfss1", - "type": "string" - }, - "name": "tableId", - "in": "path", - "required": true, - "description": "Unique Table ID" - } - ], - "get": { - "summary": "Read Table", - "operationId": "db-table-read", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Table" - }, - "examples": { - "Example 1": { - "value": { - "id": "md_rsu68aqjsbyqtl", - "base_id": "ds_g4ccx6e77h1dmi", - "project_id": "p_xm3thidrblw4n7", - "table_name": "nc_vm5q___Table1", - "title": "Table1", - "type": "table", - "meta": null, - "schema": null, - "enabled": 1, - "mm": 0, - "tags": null, - "pinned": null, - "deleted": null, - "order": 1, - "created_at": "2023-03-02 17:04:06", - "updated_at": "2023-03-02 17:04:08", - "columns": [ - { - "id": "cl_phvuuwjrzcdo0g", - "base_id": "ds_g4ccx6e77h1dmi", - "project_id": "p_xm3thidrblw4n7", - "fk_model_id": "md_rsu68aqjsbyqtl", - "title": "Id", - "column_name": "id", - "uidt": "ID", - "dt": "int", - "np": "10", - "ns": "0", - "clen": null, - "cop": "1", - "pk": 1, - "pv": null, - "rqd": 1, - "un": 1, - "ct": "int unsigned", - "ai": 1, - "unique": 0, - "cdf": null, - "cc": "", - "csn": null, - "dtx": "specificType", - "dtxp": "", - "dtxs": "0", - "au": 0, - "validate": null, - "virtual": null, - "deleted": null, - "system": 0, - "order": 1, - "created_at": "2023-03-02 17:04:06", - "updated_at": "2023-03-02 17:04:06", - "meta": null - }, - { - "id": "cl_c5knoi4xs4sfpt", - "base_id": "ds_g4ccx6e77h1dmi", - "project_id": "p_xm3thidrblw4n7", - "fk_model_id": "md_rsu68aqjsbyqtl", - "title": "Title", - "column_name": "title", - "uidt": "SingleLineText", - "dt": "varchar", - "np": null, - "ns": null, - "clen": "45", - "cop": "2", - "pk": 0, - "pv": 1, - "rqd": 0, - "un": 0, - "ct": "varchar(45)", - "ai": 0, - "unique": 0, - "cdf": null, - "cc": "", - "csn": "utf8mb4", - "dtx": "specificType", - "dtxp": "45", - "dtxs": null, - "au": 0, - "validate": null, - "virtual": null, - "deleted": null, - "system": 0, - "order": 2, - "created_at": "2023-03-02 17:04:06", - "updated_at": "2023-03-02 17:04:06", - "meta": null - }, - { - "id": "cl_jpl0qu4gj4rexq", - "base_id": "ds_g4ccx6e77h1dmi", - "project_id": "p_xm3thidrblw4n7", - "fk_model_id": "md_rsu68aqjsbyqtl", - "title": "CreatedAt", - "column_name": "created_at", - "uidt": "DateTime", - "dt": "timestamp", - "np": null, - "ns": null, - "clen": null, - "cop": "3", - "pk": 0, - "pv": null, - "rqd": 0, - "un": 0, - "ct": "timestamp", - "ai": 0, - "unique": 0, - "cdf": "CURRENT_TIMESTAMP", - "cc": "", - "csn": null, - "dtx": "specificType", - "dtxp": "0", - "dtxs": null, - "au": 0, - "validate": null, - "virtual": null, - "deleted": null, - "system": 0, - "order": 3, - "created_at": "2023-03-02 17:04:06", - "updated_at": "2023-03-02 17:04:06", - "meta": null - }, - { - "id": "cl_m4wkaqgqqjzoeh", - "base_id": "ds_g4ccx6e77h1dmi", - "project_id": "p_xm3thidrblw4n7", - "fk_model_id": "md_rsu68aqjsbyqtl", - "title": "UpdatedAt", - "column_name": "updated_at", - "uidt": "DateTime", - "dt": "timestamp", - "np": null, - "ns": null, - "clen": null, - "cop": "4", - "pk": 0, - "pv": null, - "rqd": 0, - "un": 0, - "ct": "timestamp", - "ai": 0, - "unique": 0, - "cdf": "CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP", - "cc": "", - "csn": null, - "dtx": "specificType", - "dtxp": "0", - "dtxs": null, - "au": 0, - "validate": null, - "virtual": null, - "deleted": null, - "system": 0, - "order": 4, - "created_at": "2023-03-02 17:04:06", - "updated_at": "2023-03-02 17:04:06", - "meta": null - } - ], - "views": [ - { - "ptn": "nc_vm5q___Table1", - "_ptn": "Table1", - "ptype": "table", - "tn": "Table1", - "_tn": "Table1", - "table_meta": null, - "id": "vw_p2jcatxz4mvcfw", - "base_id": "ds_g4ccx6e77h1dmi", - "project_id": "p_xm3thidrblw4n7", - "fk_model_id": "md_rsu68aqjsbyqtl", - "title": "Table1", - "type": 3, - "is_default": 1, - "show_system_fields": null, - "lock_type": "collaborative", - "uuid": null, - "password": null, - "show": 1, - "order": 1, - "created_at": "2023-03-02 17:04:06", - "updated_at": "2023-03-02 17:04:06", - "meta": {}, - "view": { - "fk_view_id": "vw_p2jcatxz4mvcfw", - "base_id": "ds_g4ccx6e77h1dmi", - "project_id": "p_xm3thidrblw4n7", - "uuid": null, - "created_at": "2023-03-02 17:04:06", - "updated_at": "2023-03-02 17:04:06", - "meta": null, - "row_height": null - }, - "disabled": { - "owner": false, - "creator": false, - "viewer": false, - "editor": false, - "commenter": false, - "guest": false - } - } - ], - "columnsById": { - "cl_phvuuwjrzcdo0g": { - "id": "cl_phvuuwjrzcdo0g", - "base_id": "ds_g4ccx6e77h1dmi", - "project_id": "p_xm3thidrblw4n7", - "fk_model_id": "md_rsu68aqjsbyqtl", - "title": "Id", - "column_name": "id", - "uidt": "ID", - "dt": "int", - "np": "10", - "ns": "0", - "clen": null, - "cop": "1", - "pk": 1, - "pv": null, - "rqd": 1, - "un": 1, - "ct": "int unsigned", - "ai": 1, - "unique": 0, - "cdf": null, - "cc": "", - "csn": null, - "dtx": "specificType", - "dtxp": "", - "dtxs": "0", - "au": 0, - "validate": null, - "virtual": null, - "deleted": null, - "system": 0, - "order": 1, - "created_at": "2023-03-02 17:04:06", - "updated_at": "2023-03-02 17:04:06", - "meta": null - }, - "cl_c5knoi4xs4sfpt": { - "id": "cl_c5knoi4xs4sfpt", - "base_id": "ds_g4ccx6e77h1dmi", - "project_id": "p_xm3thidrblw4n7", - "fk_model_id": "md_rsu68aqjsbyqtl", - "title": "Title", - "column_name": "title", - "uidt": "SingleLineText", - "dt": "varchar", - "np": null, - "ns": null, - "clen": "45", - "cop": "2", - "pk": 0, - "pv": 1, - "rqd": 0, - "un": 0, - "ct": "varchar(45)", - "ai": 0, - "unique": 0, - "cdf": null, - "cc": "", - "csn": "utf8mb4", - "dtx": "specificType", - "dtxp": "45", - "dtxs": null, - "au": 0, - "validate": null, - "virtual": null, - "deleted": null, - "system": 0, - "order": 2, - "created_at": "2023-03-02 17:04:06", - "updated_at": "2023-03-02 17:04:06", - "meta": null - }, - "cl_jpl0qu4gj4rexq": { - "id": "cl_jpl0qu4gj4rexq", - "base_id": "ds_g4ccx6e77h1dmi", - "project_id": "p_xm3thidrblw4n7", - "fk_model_id": "md_rsu68aqjsbyqtl", - "title": "CreatedAt", - "column_name": "created_at", - "uidt": "DateTime", - "dt": "timestamp", - "np": null, - "ns": null, - "clen": null, - "cop": "3", - "pk": 0, - "pv": null, - "rqd": 0, - "un": 0, - "ct": "timestamp", - "ai": 0, - "unique": 0, - "cdf": "CURRENT_TIMESTAMP", - "cc": "", - "csn": null, - "dtx": "specificType", - "dtxp": "0", - "dtxs": null, - "au": 0, - "validate": null, - "virtual": null, - "deleted": null, - "system": 0, - "order": 3, - "created_at": "2023-03-02 17:04:06", - "updated_at": "2023-03-02 17:04:06", - "meta": null - }, - "cl_m4wkaqgqqjzoeh": { - "id": "cl_m4wkaqgqqjzoeh", - "base_id": "ds_g4ccx6e77h1dmi", - "project_id": "p_xm3thidrblw4n7", - "fk_model_id": "md_rsu68aqjsbyqtl", - "title": "UpdatedAt", - "column_name": "updated_at", - "uidt": "DateTime", - "dt": "timestamp", - "np": null, - "ns": null, - "clen": null, - "cop": "4", - "pk": 0, - "pv": null, - "rqd": 0, - "un": 0, - "ct": "timestamp", - "ai": 0, - "unique": 0, - "cdf": "CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP", - "cc": "", - "csn": null, - "dtx": "specificType", - "dtxp": "0", - "dtxs": null, - "au": 0, - "validate": null, - "virtual": null, - "deleted": null, - "system": 0, - "order": 4, - "created_at": "2023-03-02 17:04:06", - "updated_at": "2023-03-02 17:04:06", - "meta": null - } - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table"], - "description": "Read the table meta data by the given table ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "patch": { - "summary": "Update Table", - "operationId": "db-table-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "5a0g9yvs4e678" - }, - "example": "The table has been updated successfully" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "The table has been updated successfully" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "table_name": { - "type": "string", - "description": "Table name", - "example": "users" - }, - "title": { - "type": "string", - "description": "Table title", - "example": "Users" - }, - "project_id": { - "type": "string", - "description": "Project ID", - "example": "p_124hhlkbeasewh" - }, - "meta": { - "$ref": "#/components/schemas/Meta" - } - } - }, - "examples": { - "Example 1": { - "value": { - "table_name": "users", - "title": "Users", - "project_id": "p_124hhlkbeasewh", - "meta": null - } - } - } - } - } - }, - "description": "Update the table meta data by the given table ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "delete": { - "summary": "Delete Table", - "operationId": "db-table-delete", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "boolean" - }, - "examples": { - "Example 1": { - "value": true - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table"], - "description": "Delete the table meta data by the given table ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/projects/{projectId}/{baseId}/tables": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - }, - { - "schema": { - "type": "string", - "pattern": "ds_j04jmxh5xg10lu" - }, - "name": "baseId", - "in": "path", - "required": true, - "description": "Unique Base ID" - } - ], - "get": { - "summary": "List Tables", - "operationId": "table-list", - "responses": { - "200": { - "$ref": "#/components/responses/TableList" - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - }, - { - "schema": { - "type": "number" - }, - "in": "query", - "name": "page" - }, - { - "schema": { - "type": "number" - }, - "in": "query", - "name": "pageSize" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "sort" - }, - { - "schema": { - "type": "boolean" - }, - "in": "query", - "name": "includeM2M" - } - ], - "tags": ["Base"], - "description": "List all tables in a given Project and Base" - }, - "post": { - "summary": "Create Table", - "operationId": "table-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Table" - }, - "examples": { - "Example 1": { - "value": { - "base_id": "ds_g4ccx6e77h1dmi", - "columns": [ - { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": "CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP", - "clen": null, - "column_name": "updated_at", - "cop": "4", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "timestamp", - "deleted": null, - "dt": "timestamp", - "dtx": "specificType", - "dtxp": "0", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_m4wkaqgqqjzoeh", - "meta": null, - "np": null, - "ns": null, - "order": 4, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 0, - "system": 0, - "title": "UpdatedAt", - "uidt": "DateTime", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": "CURRENT_TIMESTAMP", - "clen": null, - "column_name": "created_at", - "cop": "3", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "timestamp", - "deleted": null, - "dt": "timestamp", - "dtx": "specificType", - "dtxp": "0", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_jpl0qu4gj4rexq", - "meta": null, - "np": null, - "ns": null, - "order": 3, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 0, - "system": 0, - "title": "CreatedAt", - "uidt": "DateTime", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": null, - "clen": "45", - "column_name": "title", - "cop": "2", - "created_at": "2023-03-02 17:04:06", - "csn": "utf8mb4", - "ct": "varchar(45)", - "deleted": null, - "dt": "varchar", - "dtx": "specificType", - "dtxp": "45", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_c5knoi4xs4sfpt", - "meta": null, - "np": null, - "ns": null, - "order": 2, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": 1, - "rqd": 0, - "system": 0, - "title": "Title", - "uidt": "SingleLineText", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - { - "ai": 1, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": null, - "clen": null, - "column_name": "id", - "cop": "1", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "int unsigned", - "deleted": null, - "dt": "int", - "dtx": "specificType", - "dtxp": "", - "dtxs": "0", - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_phvuuwjrzcdo0g", - "meta": null, - "np": "10", - "ns": "0", - "order": 1, - "pk": 1, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 1, - "system": 0, - "title": "Id", - "uidt": "ID", - "un": 1, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - } - ], - "columnsById": { - "cl_c5knoi4xs4sfpt": { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": null, - "clen": "45", - "column_name": "title", - "cop": "2", - "created_at": "2023-03-02 17:04:06", - "csn": "utf8mb4", - "ct": "varchar(45)", - "deleted": null, - "dt": "varchar", - "dtx": "specificType", - "dtxp": "45", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_c5knoi4xs4sfpt", - "meta": null, - "np": null, - "ns": null, - "order": 2, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": 1, - "rqd": 0, - "system": 0, - "title": "Title", - "uidt": "SingleLineText", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - "cl_jpl0qu4gj4rexq": { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": "CURRENT_TIMESTAMP", - "clen": null, - "column_name": "created_at", - "cop": "3", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "timestamp", - "deleted": null, - "dt": "timestamp", - "dtx": "specificType", - "dtxp": "0", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_jpl0qu4gj4rexq", - "meta": null, - "np": null, - "ns": null, - "order": 3, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 0, - "system": 0, - "title": "CreatedAt", - "uidt": "DateTime", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - "cl_m4wkaqgqqjzoeh": { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": "CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP", - "clen": null, - "column_name": "updated_at", - "cop": "4", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "timestamp", - "deleted": null, - "dt": "timestamp", - "dtx": "specificType", - "dtxp": "0", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_m4wkaqgqqjzoeh", - "meta": null, - "np": null, - "ns": null, - "order": 4, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 0, - "system": 0, - "title": "UpdatedAt", - "uidt": "DateTime", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - "cl_phvuuwjrzcdo0g": { - "ai": 1, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": null, - "clen": null, - "column_name": "id", - "cop": "1", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "int unsigned", - "deleted": null, - "dt": "int", - "dtx": "specificType", - "dtxp": "", - "dtxs": "0", - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_phvuuwjrzcdo0g", - "meta": null, - "np": "10", - "ns": "0", - "order": 1, - "pk": 1, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 1, - "system": 0, - "title": "Id", - "uidt": "ID", - "un": 1, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - } - }, - "created_at": "2023-03-02 17:04:06", - "deleted": null, - "enabled": 1, - "id": "md_rsu68aqjsbyqtl", - "meta": null, - "mm": 0, - "order": 1, - "pinned": null, - "project_id": "p_xm3thidrblw4n7", - "schema": null, - "table_name": "nc_vm5q___Table1", - "tags": null, - "title": "Table1", - "type": "table", - "updated_at": "2023-03-02 17:04:08", - "views": [ - { - "_ptn": "Table1", - "_tn": "Table1", - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:04:06", - "disabled": { - "commenter": false, - "creator": false, - "editor": false, - "guest": false, - "owner": false, - "viewer": false - }, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "vw_p2jcatxz4mvcfw", - "is_default": 1, - "lock_type": "collaborative", - "meta": {}, - "order": 1, - "password": null, - "project_id": "p_xm3thidrblw4n7", - "ptn": "nc_vm5q___Table1", - "ptype": "table", - "show": 1, - "show_system_fields": null, - "table_meta": null, - "title": "Table1", - "tn": "Table1", - "type": 3, - "updated_at": "2023-03-02 17:04:06", - "uuid": null, - "view": { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:04:06", - "fk_view_id": "vw_p2jcatxz4mvcfw", - "meta": null, - "project_id": "p_xm3thidrblw4n7", - "row_height": null, - "updated_at": "2023-03-02 17:04:06", - "uuid": null - } - } - ] - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TableReq" - }, - "examples": { - "Example 1": { - "value": { - "columns": [ - { - "ai": false, - "altered": 1, - "cdf": "CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP", - "ck": false, - "clen": 45, - "column_name": "updated_at", - "ct": "varchar(45)", - "dt": "timestamp", - "dtx": "specificType", - "dtxp": "", - "dtxs": "", - "np": null, - "nrqd": true, - "ns": null, - "pk": false, - "rqd": false, - "title": "UpdatedAt", - "uicn": "", - "uidt": "DateTime", - "uip": "", - "un": false - }, - { - "ai": false, - "altered": 1, - "cdf": "CURRENT_TIMESTAMP", - "ck": false, - "clen": 45, - "column_name": "created_at", - "ct": "varchar(45)", - "dt": "timestamp", - "dtx": "specificType", - "dtxp": "", - "dtxs": "", - "np": null, - "nrqd": true, - "ns": null, - "pk": false, - "rqd": false, - "title": "CreatedAt", - "uicn": "", - "uidt": "DateTime", - "uip": "", - "un": false - }, - { - "ai": false, - "altered": 1, - "cdf": null, - "ck": false, - "clen": 45, - "column_name": "title", - "ct": "varchar(45)", - "dt": "varchar", - "dtx": "specificType", - "dtxp": "45", - "dtxs": "", - "np": null, - "nrqd": true, - "ns": null, - "pk": false, - "rqd": false, - "title": "Title", - "uicn": "", - "uidt": "SingleLineText", - "uip": "", - "un": false - }, - { - "ai": true, - "altered": 1, - "cdf": null, - "ck": false, - "clen": null, - "column_name": "id", - "ct": "int(11)", - "dt": "int", - "dtx": "integer", - "dtxp": "11", - "dtxs": "", - "np": 11, - "nrqd": false, - "ns": 0, - "pk": true, - "rqd": true, - "title": "Id", - "uicn": "", - "uidt": "ID", - "uip": "", - "un": true - } - ], - "table_name": "Sheet-1", - "title": "Sheet-1" - } - } - } - } - } - }, - "tags": ["Base"], - "description": "Create a new table in a given Project and Base", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/tables/{tableId}/reorder": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "md_w9gpnaousnfss1", - "type": "string" - }, - "name": "tableId", - "in": "path", - "required": true, - "description": "Unique Table ID" - } - ], - "post": { - "summary": "Reorder Table", - "operationId": "db-table-reorder", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "boolean" - }, - "examples": { - "Example 1": { - "value": true - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "order": { - "type": "number" - } - } - }, - "examples": { - "Example 1": { - "value": { - "order": 0 - } - } - } - } - } - }, - "tags": ["DB Table"], - "description": "Update the order of the given Table", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/tables/{tableId}/columns": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "md_w9gpnaousnfss1", - "type": "string" - }, - "name": "tableId", - "in": "path", - "required": true, - "description": "Unique Table ID" - } - ], - "post": { - "summary": "Create Column", - "operationId": "db-table-column-create", - "responses": { - "200": { - "description": "OK" - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ColumnReq" - }, - "examples": { - "Example 1": { - "value": { - "ai": 0, - "au": 0, - "base_id": "ds_krsappzu9f8vmo", - "cc": "", - "cdf": null, - "clen": "45", - "column_name": "title", - "cop": "2", - "csn": "utf8mb4", - "ct": "varchar(45)", - "deleted": null, - "dt": "varchar", - "dtx": "specificType", - "dtxp": "45", - "dtxs": null, - "fk_model_id": "md_yvwvbt2i78rgcm", - "id": "cl_0j9gv0oi8vjy46", - "meta": null, - "np": null, - "ns": null, - "order": 2, - "pk": 0, - "project_id": "p_01clqvzik3izk6", - "pv": 1, - "rqd": 0, - "system": 0, - "title": "Title", - "uidt": "SingleLineText", - "un": 0, - "unique": 0, - "validate": null, - "virtual": null - } - } - } - } - } - }, - "tags": ["DB Table Column"], - "description": "Create a new column in a given Table", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/columns/{columnId}": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "columnId", - "in": "path", - "required": true - } - ], - "patch": { - "summary": "Update Column", - "operationId": "db-table-column-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Column" - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ColumnReq" - } - } - } - }, - "tags": ["DB Table Column"], - "description": "Update the existing column by the given column ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "delete": { - "summary": "Delete Column", - "operationId": "db-table-column-delete", - "responses": { - "200": { - "description": "OK" - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Column"], - "description": "Delete the existing column by the given column ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "get": { - "summary": "Get Column", - "operationId": "db-table-column-get", - "responses": { - "200": { - "description": "OK" - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Column"], - "description": "Get the existing column by the given column ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/columns/{columnId}/primary": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "columnId", - "in": "path", - "required": true - } - ], - "post": { - "summary": "Create Primary Value", - "operationId": "db-table-column-primary-column-set", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "boolean" - }, - "examples": { - "Example 1": { - "value": true - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Column"], - "description": "Set a primary value on a given column", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/tables/{tableId}/views": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "md_w9gpnaousnfss1", - "type": "string" - }, - "name": "tableId", - "in": "path", - "required": true, - "description": "Unique Table ID" - } - ], - "get": { - "summary": "List Views", - "operationId": "db-view-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ViewList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "alias": "string", - "column": [ - { - "alias": "string", - "auto_increment": true, - "auto_update_timestamp": true, - "base_id": "string", - "character_maximum_length": "string", - "character_set_name": "string", - "colOptions": { - "deleted": "string", - "dr": "string", - "fk_child_column_id": "string", - "fk_column_id": "string", - "fk_index_name": "string", - "fk_mm_child_column_id": "string", - "fk_mm_model_id": "string", - "fk_mm_parent_column_id": "string", - "fk_parent_column_id": "string", - "id": "string", - "order": "string", - "type": "string", - "ur": "string", - "virtual": true - }, - "column_comment": "string", - "column_default": "string", - "column_ordinal_position": "string", - "column_type": "string", - "data_type": "string", - "data_type_x": "string", - "data_type_x_precision": "string", - "data_type_x_scale": "string", - "deleted": true, - "fk_model_id": "string", - "id": "string", - "numeric_precision": "string", - "numeric_scale": "string", - "order": 0, - "primary_key": true, - "primary_value": true, - "rqd": "string", - "title": "string", - "ui_data_type": "string", - "un": "string", - "unique": true, - "visible": true - } - ], - "columnByIds": {}, - "deleted": true, - "enabled": true, - "fk_base_id": "string", - "fk_project_id": "string", - "id": "string", - "order": 0, - "parent_id": "string", - "pinned": true, - "show_as": "string", - "tags": "string", - "title": "string", - "type": "string" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "description": "List all views in a given Table.", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/views/{viewId}": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "vw_wtdg2meyig5l4q" - }, - "name": "viewId", - "in": "path", - "required": true, - "description": "Unique View ID" - } - ], - "patch": { - "summary": "Update View", - "operationId": "db-view-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/View" - }, - "examples": { - "Example 1": { - "value": { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:46:31", - "fk_model_id": "md_mhs9z4r2ak98x0", - "id": "vw_lg052cnc1c26kf", - "is_default": 1, - "lock_type": "collaborative", - "meta": "{\"allowCSVDownload\":true}", - "order": 1, - "password": "password123", - "project_id": "p_xm3thidrblw4n7", - "show": 1, - "show_system_fields": null, - "title": "Grid View 1", - "type": 3, - "updated_at": "2023-03-02 17:46:31", - "uuid": null - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ViewUpdateReq" - }, - "examples": { - "Example 1": { - "value": { - "title": "Grid View 1", - "uuid": "e2457bbf-e29c-4fec-866e-fe3b01dba57f", - "password": "password123", - "lock_type": "collaborative", - "meta": "{\"allowCSVDownload\":true}", - "order": 1, - "show_system_fields": 0 - } - } - } - } - } - }, - "tags": ["DB View"], - "description": "Update the view with the given view Id.", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "delete": { - "summary": "Delete View", - "operationId": "db-view-delete", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "boolean" - }, - "examples": { - "Example 1": { - "value": true - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "description": "Delete the view with the given view Id.", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/views/{viewId}/show-all": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "vw_wtdg2meyig5l4q" - }, - "name": "viewId", - "in": "path", - "required": true, - "description": "Unique View ID" - } - ], - "post": { - "summary": "Show All Columns In View", - "operationId": "db-view-show-all-column", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "boolean" - }, - "examples": { - "Example 1": { - "value": true - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "description": "Show All Columns in a given View", - "parameters": [ - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "ignoreIds" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/views/{viewId}/hide-all": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "vw_wtdg2meyig5l4q" - }, - "name": "viewId", - "in": "path", - "required": true, - "description": "Unique View ID" - } - ], - "post": { - "summary": "Hide All Columns In View", - "operationId": "db-view-hide-all-column", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "boolean" - }, - "examples": { - "Example 1": { - "value": true - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "parameters": [ - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "ignoreIds" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "description": "Hide All Columns in a given View" - } - }, - "/api/v1/db/meta/tables/{tableId}/share": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "md_w9gpnaousnfss1", - "type": "string" - }, - "name": "tableId", - "in": "path", - "required": true, - "description": "Unique Table ID" - } - ], - "get": { - "summary": "List Shared Views", - "operationId": "db-view-share-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SharedViewList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:46:31", - "fk_model_id": "md_mhs9z4r2ak98x0", - "id": "vw_lg052cnc1c26kf", - "is_default": 1, - "lock_type": "collaborative", - "meta": {}, - "order": 1, - "project_id": "p_xm3thidrblw4n7", - "show": 1, - "show_system_fields": null, - "title": "Sheet-1", - "type": 3, - "updated_at": "2023-03-02 17:46:31", - "uuid": null, - "view": { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:46:31", - "fk_view_id": "vw_lg052cnc1c26kf", - "meta": null, - "project_id": "p_xm3thidrblw4n7", - "row_height": null, - "updated_at": "2023-03-02 17:46:31", - "uuid": null - } - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "List all shared views in a given Table", - "tags": ["DB View Share"], - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/views/{viewId}/share": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "vw_wtdg2meyig5l4q" - }, - "name": "viewId", - "in": "path", - "required": true, - "description": "Unique View ID" - } - ], - "post": { - "summary": "Create Shared View", - "operationId": "db-view-share-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SharedViewReq" - }, - "examples": { - "Example 1": { - "value": { - "meta": {}, - "password": "123456789" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View Share"], - "description": "Create a shared view in a given View..", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "patch": { - "summary": "Update Shared View", - "operationId": "db-view-share-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SharedView" - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SharedViewReq" - } - } - }, - "description": "" - }, - "tags": ["DB View Share"], - "description": "Update a shared view in a given View..", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "delete": { - "summary": "Delete Shared View", - "operationId": "db-view-share-delete", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "boolean" - }, - "examples": { - "Example 1": { - "value": true - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Delete a shared view in a given View.", - "tags": ["DB View Share"], - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/views/{viewId}/columns": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "vw_wtdg2meyig5l4q" - }, - "name": "viewId", - "in": "path", - "required": true, - "description": "Unique View ID" - } - ], - "get": { - "summary": "List Columns In View", - "operationId": "db-view-column-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ColumnList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "ai": 0, - "au": 0, - "base_id": "ds_krsappzu9f8vmo", - "cc": "", - "cdf": null, - "clen": "45", - "column_name": "title", - "cop": "2", - "created_at": "2023-03-02 13:14:16", - "csn": "utf8mb4", - "ct": "varchar(45)", - "deleted": null, - "dt": "varchar", - "dtx": "specificType", - "dtxp": "45", - "dtxs": null, - "fk_model_id": "md_yvwvbt2i78rgcm", - "id": "cl_0j9gv0oi8vjy46", - "meta": null, - "np": null, - "ns": null, - "order": 2, - "pk": 0, - "project_id": "p_01clqvzik3izk6", - "pv": 1, - "rqd": 0, - "system": 0, - "title": "Title", - "uidt": "SingleLineText", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 13:14:16", - "validate": null, - "virtual": null - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View Column"], - "description": "List all columns by ViewID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "post": { - "summary": "Create Column in View", - "operationId": "db-view-column-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Column" - }, - "examples": { - "Example 1": { - "value": { - "ai": 0, - "au": 0, - "base_id": "ds_krsappzu9f8vmo", - "cc": "", - "cdf": null, - "clen": "45", - "column_name": "title", - "cop": "2", - "created_at": "2023-03-02 13:14:16", - "csn": "utf8mb4", - "ct": "varchar(45)", - "deleted": null, - "dt": "varchar", - "dtx": "specificType", - "dtxp": "45", - "dtxs": null, - "fk_model_id": "md_yvwvbt2i78rgcm", - "id": "cl_0j9gv0oi8vjy46", - "meta": null, - "np": null, - "ns": null, - "order": 2, - "pk": 0, - "project_id": "p_01clqvzik3izk6", - "pv": 1, - "rqd": 0, - "system": 0, - "title": "Title", - "uidt": "SingleLineText", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 13:14:16", - "validate": null, - "virtual": null - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View Column"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ViewColumnReq" - }, - "examples": { - "Example 1": { - "value": { - "fk_column_id": "cl_m4wkaqgqqjzoeh", - "show": 0, - "order": 1 - } - } - } - } - } - }, - "description": "Create a new column in a given View", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/views/{viewId}/columns/{columnId}": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "vw_wtdg2meyig5l4q" - }, - "name": "viewId", - "in": "path", - "required": true - }, - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "cl_8iw2o4ejzvdyna", - "type": "string" - }, - "name": "columnId", - "in": "path", - "required": true, - "description": "Unique Column ID" - } - ], - "patch": { - "summary": "Update View Column", - "operationId": "db-view-column-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number" - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View Column"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ViewColumnUpdateReq" - }, - "examples": { - "Example 1": { - "value": { - "show": 0, - "order": 1 - } - } - } - } - } - }, - "description": "Update a column in a View", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/views/{viewId}/sorts": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "vw_wtdg2meyig5l4q" - }, - "name": "viewId", - "in": "path", - "required": true, - "description": "Unique View ID" - } - ], - "get": { - "summary": "List View Sorts", - "operationId": "db-table-sort-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SortList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "id": "so_xd4t51uv60ghzl", - "fk_column_id": "cl_l11b769pe2j1ce", - "fk_model_id": "md_ehn5izr99m7d45", - "base_id": "ds_3l9qx8xqksenrl", - "direction": "desc", - "order": 1, - "project_id": "p_9sx43moxhqtjm3" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Sort"], - "description": "List all the sort data in a given View", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "post": { - "summary": "Update View Sort", - "operationId": "db-table-sort-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number" - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Sort"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/SortReq" - }, - { - "type": "object", - "properties": { - "push_to_top": { - "type": "boolean", - "example": true, - "description": "Push the sort to the top of the list" - } - } - } - ] - } - } - } - }, - "description": "Update the sort data in a given View", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/sorts/{sortId}": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "so_xd4t51uv60ghzl" - }, - "name": "sortId", - "in": "path", - "description": "Unique Sort ID", - "required": true - } - ], - "get": { - "summary": "Get Sort", - "operationId": "db-table-sort-get", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Sort" - }, - "examples": { - "Example 1": { - "value": { - "id": "so_xd4t51uv60ghzl", - "fk_column_id": "cl_l11b769pe2j1ce", - "fk_model_id": "md_ehn5izr99m7d45", - "base_id": "ds_3l9qx8xqksenrl", - "direction": "desc", - "order": 1, - "project_id": "p_9sx43moxhqtjm3" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Sort"], - "description": "Get the sort data by Sort ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "patch": { - "summary": "Update Sort", - "operationId": "db-table-sort-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number", - "example": 1 - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Sort"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SortReq" - }, - "examples": { - "Example 1": { - "value": { - "direction": "asc", - "fk_column_id": "cl_l11b769pe2j1ce" - } - } - } - } - } - }, - "description": "Update the sort data by Sort ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "delete": { - "summary": "Delete Sort", - "operationId": "db-table-sort-delete", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "boolean" - }, - "examples": { - "Example 1": { - "value": true - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Sort"], - "description": "Delete the sort data by Sort ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/views/{viewId}/filters": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "vw_wtdg2meyig5l4q" - }, - "name": "viewId", - "in": "path", - "required": true, - "description": "Unique View ID" - } - ], - "get": { - "summary": "Get View Filter", - "operationId": "db-table-filter-read", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FilterList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "comparison_op": "eq", - "comparison_sub_op": null, - "created_at": "2023-03-02 18:18:05", - "fk_column_id": "cl_d7ah9n2qfupgys", - "fk_hook_id": null, - "fk_parent_id": null, - "fk_view_id": "vw_b739e29vqmrxnf", - "id": "fi_xn647tpmdq8fu8", - "is_group": null, - "logical_op": "and", - "order": 1, - "project_id": "p_xm3thidrblw4n7", - "updated_at": "2023-03-02 18:18:05", - "value": "foo" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Filter"], - "description": "Get the filter data in a given View", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "post": { - "summary": "Create View Filter", - "operationId": "db-table-filter-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Filter" - }, - "examples": { - "Example 1": { - "value": { - "base_id": "ds_g4ccx6e77h1dmi", - "comparison_op": "eq", - "comparison_sub_op": null, - "created_at": "2023-03-02 18:18:05", - "fk_column_id": "cl_d7ah9n2qfupgys", - "fk_hook_id": null, - "fk_parent_id": null, - "fk_view_id": "vw_b739e29vqmrxnf", - "id": "fi_xn647tpmdq8fu8", - "is_group": null, - "logical_op": "and", - "order": 1, - "project_id": "p_xm3thidrblw4n7", - "updated_at": "2023-03-02 18:18:05", - "value": "foo" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Filter"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FilterReq" - }, - "examples": { - "Example 1": { - "value": { - "comparison_op": "eq", - "comparison_sub_op": null, - "fk_column_id": "cl_d7ah9n2qfupgys", - "is_group": false, - "logical_op": "and", - "value": "foo" - } - } - } - } - } - }, - "description": "Update the filter data in a given View", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/hooks/{hookId}/filters": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "hk_0063k4o1frnxbr" - }, - "name": "hookId", - "in": "path", - "required": true, - "description": "Unique Hook ID" - } - ], - "get": { - "summary": "Get Hook Filter", - "operationId": "db-table-webhook-filter-read", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FilterList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "comparison_op": "eq", - "comparison_sub_op": null, - "created_at": "2023-03-02 18:18:05", - "fk_column_id": "cl_d7ah9n2qfupgys", - "fk_hook_id": null, - "fk_parent_id": null, - "fk_view_id": "vw_b739e29vqmrxnf", - "id": "fi_xn647tpmdq8fu8", - "is_group": null, - "logical_op": "and", - "order": 1, - "project_id": "p_xm3thidrblw4n7", - "updated_at": "2023-03-02 18:18:05", - "value": "foo" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Webhook Filter"], - "description": "Get the filter data in a given Hook", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "post": { - "summary": "Create Hook Filter", - "operationId": "db-table-webhook-filter-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Filter" - }, - "examples": { - "Example 1": { - "value": { - "base_id": "ds_g4ccx6e77h1dmi", - "comparison_op": "eq", - "comparison_sub_op": null, - "created_at": "2023-03-02 18:18:05", - "fk_column_id": "cl_d7ah9n2qfupgys", - "fk_hook_id": null, - "fk_parent_id": null, - "fk_view_id": "vw_b739e29vqmrxnf", - "id": "fi_xn647tpmdq8fu8", - "is_group": null, - "logical_op": "and", - "order": 1, - "project_id": "p_xm3thidrblw4n7", - "updated_at": "2023-03-02 18:18:05", - "value": "foo" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Webhook Filter"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FilterReq" - }, - "examples": { - "Example 1": { - "value": { - "comparison_op": "eq", - "comparison_sub_op": null, - "fk_column_id": "cl_d7ah9n2qfupgys", - "is_group": false, - "logical_op": "and", - "value": "foo" - } - } - } - } - } - }, - "description": "Create filter(s) in a given Hook", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/hooks/{hookId}/logs": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "hk_0063k4o1frnxbr" - }, - "name": "hookId", - "in": "path", - "required": true, - "description": "Unique Hook ID" - } - ], - "get": { - "summary": "List Hook Logs", - "operationId": "db-table-webhook-logs-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HookLogList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "base_id": "ds_jxuewivwbxeum2", - "event": "after", - "execution_time": "98", - "fk_hook_id": "hk_035ijv5qdi97y5", - "id": "string", - "notifications": "{\"type\":\"URL\",\"payload\":{\"method\":\"POST\",\"body\":\"{{ json data }}\",\"headers\":[{}],\"parameters\":[{}],\"auth\":\"\",\"path\":\"https://webhook.site/6eb45ce5-b611-4be1-8b96-c2965755662b\"}}", - "operation": "insert", - "payload": "{\"method\":\"POST\",\"body\":\"{{ json data }}\",\"headers\":[{}],\"parameters\":[{}],\"auth\":\"\",\"path\":\"https://webhook.site/6eb45ce5-b611-4be1-8b96-c2965755662b\"}", - "project_id": "p_tbhl1hnycvhe5l", - "response": "{\"status\":200,\"statusText\":\"OK\",\"headers\":{\"server\":\"nginx\",\"content-type\":\"text/plain; charset=UTF-8\",\"transfer-encoding\":\"chunked\",\"connection\":\"close\",\"vary\":\"Accept-Encoding\",\"x-request-id\":\"53844a7d-ede8-4798-adf7-8af441908a72\",\"x-token-id\":\"6eb45ce5-b611-4be1-8b96-c2965755662b\",\"cache-control\":\"no-cache, private\",\"date\":\"Fri, 24 Mar 2023 10:50:10 GMT\"},\"config\":{\"url\":\"https://webhook.site/6eb45ce5-b611-4be1-8b96-c2965755662b\",\"method\":\"post\",\"data\":\"{\\\"type\\\":\\\"records.after.insert\\\",\\\"id\\\":\\\"a77d97dc-a3e4-4719-9b46-45f93e0cc99a\\\",\\\"data\\\":{\\\"table_id\\\":\\\"md_d8v403o74mf5lf\\\",\\\"table_name\\\":\\\"Sheet-2\\\"}}\",\"headers\":{\"Accept\":\"application/json, text/plain, */*\",\"Content-Type\":\"application/x-www-form-urlencoded\",\"User-Agent\":\"axios/0.21.4\",\"Content-Length\":138},\"params\":{}}}", - "test_call": 0, - "triggered_by": "w@nocodb.com", - "type": "URL" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Webhook Logs"], - "description": "List the log data in a given Hook", - "parameters": [ - { - "schema": { - "type": "integer", - "minimum": 1 - }, - "in": "query", - "name": "limit" - }, - { - "schema": { - "type": "integer", - "minimum": 0 - }, - "in": "query", - "name": "offset" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/filters/{filterId}": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "pattern": "fi_pgfuo11uhn2xeo" - }, - "name": "filterId", - "in": "path", - "required": true, - "description": "Unique Filter ID" - } - ], - "get": { - "summary": "Get Filter", - "operationId": "db-table-filter-get", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Filter" - }, - "examples": { - "Example 1": { - "value": { - "base_id": "ds_g4ccx6e77h1dmi", - "comparison_op": "eq", - "comparison_sub_op": null, - "created_at": "2023-03-02 18:18:05", - "fk_column_id": "cl_d7ah9n2qfupgys", - "fk_hook_id": null, - "fk_parent_id": null, - "fk_view_id": "vw_b739e29vqmrxnf", - "id": "fi_xn647tpmdq8fu8", - "is_group": null, - "logical_op": "and", - "order": 1, - "project_id": "p_xm3thidrblw4n7", - "updated_at": "2023-03-02 18:18:05", - "value": "foo" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Filter"], - "description": "Get the filter data with a given Filter ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "patch": { - "summary": "Update Filter", - "operationId": "db-table-filter-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number" - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Filter"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FilterReq" - }, - "examples": { - "Example 1": { - "value": { - "comparison_op": "eq", - "comparison_sub_op": null, - "fk_column_id": "cl_d7ah9n2qfupgys", - "is_group": false, - "logical_op": "and", - "value": "foo" - } - } - } - } - } - }, - "description": "Update the filter data with a given Filter ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "delete": { - "summary": "Delete Filter", - "operationId": "db-table-filter-delete", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "boolean" - }, - "examples": { - "Example 1": { - "value": true - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Filter"], - "description": "Delete the filter data with a given Filter ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/filters/{filterGroupId}/children": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "fi_pgfuo11uhn2xeo", - "description": "Filter Group ID" - }, - "name": "filterGroupId", - "in": "path", - "required": true - } - ], - "get": { - "summary": "Get Filter Group Children", - "operationId": "db-table-filter-children-read", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FilterList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "comparison_op": "eq", - "comparison_sub_op": null, - "created_at": "2023-03-02 18:18:05", - "fk_column_id": "cl_d7ah9n2qfupgys", - "fk_hook_id": null, - "fk_parent_id": null, - "fk_view_id": "vw_b739e29vqmrxnf", - "id": "fi_xn647tpmdq8fu8", - "is_group": null, - "logical_op": "and", - "order": 1, - "project_id": "p_xm3thidrblw4n7", - "updated_at": "2023-03-02 18:18:05", - "value": "foo" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Filter"], - "description": "Get Filter Group Children of a given group ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/tables/{tableId}/grids": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "md_w9gpnaousnfss1", - "type": "string" - }, - "name": "tableId", - "in": "path", - "required": true, - "description": "Unique Table ID" - } - ], - "post": { - "summary": "Create Grid View", - "operationId": "db-view-grid-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/View" - }, - "examples": { - "Example 1": { - "value": { - "id": "vw_o50jiw9v2txktv", - "base_id": "ds_a95vextjl510z7", - "project_id": "p_slkm6i3v31q4bc", - "fk_model_id": "md_8hr3xndx8umuce", - "title": "Grid-1", - "type": 3, - "is_default": null, - "show_system_fields": null, - "lock_type": "collaborative", - "uuid": null, - "password": null, - "show": true, - "order": 2, - "created_at": "2023-03-13T07:29:16.610Z", - "updated_at": "2023-03-13T07:29:16.610Z", - "meta": {} - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ViewCreateReq" - }, - "examples": { - "Example 1": { - "value": { - "title": "My Grid View", - "type": 3, - "copy_from_id": null, - "fk_grp_col_id": null, - "fk_geo_data_col_id": null - } - } - } - } - } - }, - "description": "Create a new grid view in a given Table", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/tables/{tableId}/forms": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "md_w9gpnaousnfss1", - "type": "string" - }, - "name": "tableId", - "in": "path", - "required": true, - "description": "Unique Table ID" - } - ], - "post": { - "summary": "Create Form View", - "operationId": "db-view-form-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/View" - }, - "examples": { - "Example 1": { - "value": { - "id": "vw_a830n4bmwk8wlp", - "base_id": "ds_a95vextjl510z7", - "project_id": "p_slkm6i3v31q4bc", - "fk_model_id": "md_8hr3xndx8umuce", - "title": "Form-1", - "type": 1, - "is_default": null, - "show_system_fields": null, - "lock_type": "collaborative", - "uuid": null, - "password": null, - "show": true, - "order": 4, - "created_at": "2023-03-13T07:29:19.957Z", - "updated_at": "2023-03-13T07:29:19.957Z", - "meta": {} - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Create a new form view in a given Table", - "tags": ["DB View"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ViewCreateReq" - }, - "examples": { - "Example 1": { - "value": { - "title": "My Form View", - "type": 1, - "copy_from_id": null, - "fk_grp_col_id": null, - "fk_geo_data_col_id": null - } - } - } - } - } - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/forms/{formViewId}": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "vw_6fqln9vdytdv8q" - }, - "name": "formViewId", - "in": "path", - "required": true, - "description": "Unique Form View ID" - } - ], - "patch": { - "summary": "Update Form View", - "operationId": "db-view-form-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number" - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FormUpdateReq" - }, - "examples": { - "Example 1": { - "value": { - "banner_image_url": null, - "email": "user@example.com", - "heading": "My Form", - "lock_type": "collaborative", - "logo_url": null, - "meta": null, - "redirect_after_secs": null, - "redirect_url": null, - "show_blank_form": 0, - "subheading": "My Form Subheading", - "submit_another_form": 0, - "success_msg": "Thank you for the submission.", - "title": "Form View 1" - } - } - } - } - } - }, - "description": "Update the form data by Form ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "get": { - "summary": "Get Form", - "operationId": "db-view-form-read", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Form" - }, - "examples": { - "Example 1": { - "value": { - "base_id": "ds_g4ccx6e77h1dmi", - "banner_image_url": null, - "columns": [ - { - "id": "fvc_ugj9zo5bzocxtl", - "base_id": "ds_g4ccx6e77h1dmi", - "project_id": "p_xm3thidrblw4n7", - "fk_view_id": "vw_kdf5cr7qmhksek", - "fk_column_id": "cl_phvuuwjrzcdo0g", - "uuid": null, - "label": null, - "help": null, - "description": null, - "required": null, - "show": 0, - "order": 1, - "created_at": "2023-03-04 16:40:47", - "updated_at": "2023-03-04 16:40:47", - "meta": {} - } - ], - "email": "user@example.com", - "fk_model_id": "md_rsu68aqjsbyqtl", - "heading": "My Form", - "lock_type": "collaborative", - "logo_url": null, - "meta": null, - "redirect_after_secs": null, - "redirect_url": null, - "show_blank_form": 0, - "subheading": "My Form Subheading", - "submit_another_form": 0, - "success_msg": "Thank you for the submission.", - "title": "Form View 1" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "description": "Get the form data by Form ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/form-columns/{formViewColumnId}": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "fvc_1m9b0aub791d4m", - "type": "string" - }, - "name": "formViewColumnId", - "in": "path", - "required": true, - "description": "Unique Form View Column ID" - } - ], - "patch": { - "summary": "Update Form Column", - "operationId": "db-view-form-column-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FormColumnReq" - }, - "examples": { - "Example 1": { - "value": { - "description": null, - "help": "This is a help text", - "label": "Form Label", - "meta": null, - "order": 1, - "required": 0, - "show": 0 - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FormColumnReq" - } - } - } - }, - "description": "Update the form column(s) by Form View Column ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/grids/{viewId}": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "vw_wtdg2meyig5l4q" - }, - "name": "viewId", - "in": "path", - "required": true, - "description": "Unique View ID" - } - ], - "patch": { - "summary": "Update Grid View", - "operationId": "db-view-grid-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number" - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GridUpdateReq" - }, - "examples": { - "Example 1": { - "value": { - "row_height": 1, - "meta": null - } - } - } - } - } - }, - "description": "Update Grid View", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/grids/{gridId}/grid-columns": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "vw_q6k13mmygdi3yz" - }, - "name": "gridId", - "in": "path", - "required": true, - "description": "Grid View ID" - } - ], - "get": { - "summary": "List Grid Columns", - "operationId": "db-view-grid-columns-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GridColumn" - } - }, - "examples": { - "Example 1": { - "value": [ - { - "id": "nc_c8jz4kxe6xvh11", - "fk_view_id": "vw_p2jcatxz4mvcfw", - "fk_column_id": "cl_c5knoi4xs4sfpt", - "project_id": "p_xm3thidrblw4n7", - "base_id": "ds_g4ccx6e77h1dmi", - "show": 0, - "order": 1, - "width": "200px", - "help": null - } - ] - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "description": "List all columns in the given Grid", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/grid-columns/{columnId}": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "cl_8iw2o4ejzvdyna", - "type": "string" - }, - "name": "columnId", - "in": "path", - "required": true, - "description": "Unique Column ID" - } - ], - "patch": { - "summary": "Update Grid Column", - "operationId": "db-view-grid-column-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number" - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GridColumnReq" - }, - "examples": { - "Example 1": { - "value": { - "fk_column_id": "cl_c5knoi4xs4sfpt", - "label": "My Column", - "width": "200px" - } - } - } - } - } - }, - "description": "Update grid column(s) in the given Grid", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/tables/{tableId}/galleries": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "md_w9gpnaousnfss1" - }, - "name": "tableId", - "in": "path", - "required": true, - "description": "Unique Table ID" - } - ], - "post": { - "summary": "Create Gallery View", - "operationId": "db-view-gallery-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/View" - }, - "examples": { - "Example 1": { - "value": { - "id": "vw_qp94qfnvffgk5f", - "base_id": "ds_a95vextjl510z7", - "project_id": "p_slkm6i3v31q4bc", - "fk_model_id": "md_8hr3xndx8umuce", - "title": "Gallery-1", - "type": 2, - "is_default": null, - "show_system_fields": null, - "lock_type": "collaborative", - "uuid": null, - "password": null, - "show": true, - "order": 3, - "created_at": "2023-03-13T07:29:18.707Z", - "updated_at": "2023-03-13T07:29:18.707Z", - "meta": {} - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ViewCreateReq" - }, - "examples": { - "Example 1": { - "value": { - "title": "My Gallery View", - "type": 2, - "copy_from_id": null, - "fk_grp_col_id": null, - "fk_geo_data_col_id": null - } - } - } - } - } - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/galleries/{galleryViewId}": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "vw_1eq2wk2xe3a9j5" - }, - "name": "galleryViewId", - "in": "path", - "required": true, - "description": "Unique Gallery View ID" - } - ], - "patch": { - "summary": "Update Gallery View", - "operationId": "db-view-gallery-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number" - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GalleryUpdateReq" - }, - "examples": { - "Example 1": { - "value": { - "fk_cover_image_col_id": "cl_ib8l4j1kiu1efx", - "meta": null - } - } - } - } - } - }, - "description": "Update the Gallery View data with Gallery ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "get": { - "summary": "Get Gallery View", - "operationId": "db-view-gallery-read", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Gallery" - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "description": "Get the Gallery View data with Gallery ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/tables/{tableId}/kanbans": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "md_w9gpnaousnfss1", - "type": "string" - }, - "name": "tableId", - "in": "path", - "required": true, - "description": "Unique Table ID" - } - ], - "post": { - "summary": "Create Kanban View", - "operationId": "db-view-kanban-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/View" - }, - "examples": { - "Example 1": { - "value": { - "id": "vw_569sqsrp2vuff4", - "base_id": "ds_a95vextjl510z7", - "project_id": "p_slkm6i3v31q4bc", - "fk_model_id": "md_8hr3xndx8umuce", - "title": "Kanban-1", - "type": 4, - "is_default": null, - "show_system_fields": null, - "lock_type": "collaborative", - "uuid": null, - "password": null, - "show": true, - "order": 5, - "created_at": "2023-03-13T07:29:21.387Z", - "updated_at": "2023-03-13T07:29:21.387Z", - "meta": {} - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ViewCreateReq" - }, - "examples": { - "Example 1": { - "value": { - "title": "My Kanban View", - "type": 4, - "copy_from_id": null, - "fk_grp_col_id": "cl_g0a89q9xdry3lu", - "fk_geo_data_col_id": null - } - } - } - } - } - }, - "description": "Create a new Kanban View", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/kanbans/{kanbanViewId}": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "vw_1eq2wk2xe3a9j5" - }, - "name": "kanbanViewId", - "in": "path", - "required": true, - "description": "Unique Kanban View ID" - } - ], - "patch": { - "summary": "Update Kanban View", - "operationId": "db-view-kanban-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number" - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/KanbanUpdateReq" - }, - "examples": { - "Example 1": { - "value": { - "fk_grp_col_id": "cl_g0a89q9xdry3lu", - "fk_cover_image_col_id": "cl_ib8l4j1kiu1efx", - "meta": { - "cl_g0a89q9xdry3lu": [ - { - "id": "uncategorized", - "title": null, - "order": 0, - "color": "#c2f5e8", - "collapsed": false - }, - { - "id": "sl_ihyva6jx6dg0fc", - "fk_column_id": "cl_g0a89q9xdry3lu", - "title": "a", - "color": "#cfdffe", - "order": 1, - "collapsed": false - }, - { - "id": "sl_gqdm5v6t8aetoa", - "fk_column_id": "cl_g0a89q9xdry3lu", - "title": "b", - "color": "#d0f1fd", - "order": 2, - "collapsed": false - }, - { - "id": "sl_eipnl0kn7a9d3c", - "fk_column_id": "cl_g0a89q9xdry3lu", - "title": "cc", - "color": "#c2f5e8", - "order": 3, - "collapsed": false - }, - { - "id": "sl_dei8p2jq0cnlv0", - "fk_column_id": "cl_g0a89q9xdry3lu", - "title": "d", - "color": "#ffdaf6", - "order": 4, - "collapsed": false - } - ] - } - } - } - } - } - } - }, - "description": "Update the Kanban View data with Kanban ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "get": { - "summary": "Get Kanban View", - "operationId": "db-view-kanban-read", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Kanban" - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "description": "Get the Kanban View data by Kanban ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/tables/{tableId}/maps": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "md_w9gpnaousnfss1", - "type": "string" - }, - "name": "tableId", - "in": "path", - "required": true, - "description": "Unique Table ID" - } - ], - "post": { - "summary": "Create Map View", - "operationId": "db-view-map-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/View" - }, - "examples": { - "Example 1": { - "value": { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:46:31", - "fk_model_id": "md_mhs9z4r2ak98x0", - "id": "vw_lg052cnc1c26kf", - "is_default": 1, - "lock_type": "collaborative", - "meta": {}, - "order": 1, - "password": null, - "project_id": "p_xm3thidrblw4n7", - "show": 1, - "show_system_fields": null, - "title": "Sheet-1", - "type": 3, - "updated_at": "2023-03-02 17:46:31", - "uuid": null - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ViewCreateReq" - }, - "examples": { - "Example 1": { - "value": { - "title": "My Map View", - "type": 5, - "copy_from_id": null, - "fk_grp_col_id": null, - "fk_geo_data_col_id": "cl_uu1meolj00tlrq" - } - } - } - } - }, - "description": "" - }, - "description": "Create a new Map View", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/maps/{mapViewId}": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "vw_1eq2wk2xe3a9j5" - }, - "name": "mapViewId", - "in": "path", - "required": true, - "description": "Unique Map View ID" - } - ], - "patch": { - "summary": "Update Map View", - "operationId": "db-view-map-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number" - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/MapUpdateReq" - }, - "examples": { - "Example 1": { - "value": { - "fk_geo_data_col_id": "cl_8iw2o4ejzvdyna", - "meta": null - } - } - } - } - } - }, - "description": "Update the Map View data by Map ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "get": { - "summary": "Get Map View", - "operationId": "db-view-map-read", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Map" - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View"], - "description": "Get the Map View data by Map ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/projects/{projectId}/meta-diff": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - } - ], - "post": { - "summary": "Sync Meta", - "operationId": "project-meta-diff-sync", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "la6fd99uw6eao" - }, - "example": "The meta has been synchronized successfully" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "The meta has been synchronized successfully" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Project"], - "description": "Synchronise the meta data difference between NC_DB and external data sources ", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "get": { - "summary": "Meta Diff", - "operationId": "project-meta-diff-get", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["Project"], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "x-stoplight": { - "id": "awdkjwr7uultr" - }, - "type": "object", - "properties": { - "table_name": { - "type": "string", - "x-stoplight": { - "id": "jjj8ufafq1sd2" - }, - "description": "Table Name", - "example": "Table 1" - }, - "base_id": { - "type": "string", - "x-stoplight": { - "id": "smx2or6bv1xym" - }, - "description": "Base ID", - "example": "ds_rrplkgy0pq1f3c" - }, - "type": { - "type": "string", - "x-stoplight": { - "id": "zr19ahh1s6d13" - }, - "description": "Change Type", - "example": "table" - }, - "detectedChanges": { - "type": "array", - "x-stoplight": { - "id": "bptxla2y27aq6" - }, - "description": "Detected Changes", - "items": { - "x-stoplight": { - "id": "ob16o1ln7xy8o" - }, - "type": "object" - } - } - } - } - }, - "examples": { - "Example 1": { - "value": [ - { - "table_name": "_nc_m2m_uuv_xzru3m", - "base_id": "ds_rrplkgy0pq1f3c", - "type": "table", - "detectedChanges": [ - { - "type": "TABLE_NEW", - "msg": "New table" - }, - { - "type": "TABLE_RELATION_ADD", - "tn": "_nc_m2m_uuv_xzru3m", - "rtn": "Sheet-1", - "cn": "table1_id", - "rcn": "id", - "msg": "New relation added", - "relationType": "bt", - "cstn": "_nc_m2m_uuv_xzru3m_table1_id_foreign" - }, - { - "type": "TABLE_RELATION_ADD", - "tn": "_nc_m2m_uuv_xzru3m", - "rtn": "address", - "cn": "table2_id", - "rcn": "address_id", - "msg": "New relation added", - "relationType": "bt", - "cstn": "_nc_m2m_uuv_xzru3m_table2_id_foreign" - } - ] - } - ] - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Get the meta data difference between NC_DB and external data sources " - } - }, - "/api/v1/db/meta/projects/{projectId}/meta-diff/{baseId}": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - }, - { - "schema": { - "type": "string", - "pattern": "ds_j04jmxh5xg10lu" - }, - "name": "baseId", - "in": "path", - "required": true, - "description": "Unique Base ID" - } - ], - "post": { - "summary": "Synchronise Base Meta", - "operationId": "base-meta-diff-sync", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "acy7tx4rounqw" - }, - "example": "The base meta has been synchronized successfully" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "The base meta has been synchronized successfully" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Base"], - "description": "Synchronise the meta data difference between NC_DB and external data sources in a given Base", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "get": { - "summary": "Base Meta Diff", - "operationId": "base-meta-diff-get", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["Base"], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "x-stoplight": { - "id": "pav4jmel1ebeu" - }, - "type": "object", - "properties": { - "table_name": { - "type": "string", - "x-stoplight": { - "id": "xjw4k4httzmaf" - }, - "description": "Table Name", - "example": "Table 1" - }, - "base_id": { - "type": "string", - "x-stoplight": { - "id": "l1o3qhkgagsdl" - }, - "example": "ds_rrplkgy0pq1f3c", - "description": "Base ID" - }, - "type": { - "type": "string", - "x-stoplight": { - "id": "v5ciaygrj64uh" - }, - "description": "Change Type", - "example": "table" - }, - "detectedChanges": { - "type": "array", - "x-stoplight": { - "id": "wqn5noi0e46q8" - }, - "description": "Detected Changes", - "items": { - "x-stoplight": { - "id": "r2roo274wquvf" - }, - "type": "object" - } - } - } - } - }, - "examples": { - "Example 1": { - "value": [ - { - "table_name": "_nc_m2m_uuv_xzru3m", - "base_id": "ds_rrplkgy0pq1f3c", - "type": "table", - "detectedChanges": [ - { - "type": "TABLE_NEW", - "msg": "New table" - }, - { - "type": "TABLE_RELATION_ADD", - "tn": "_nc_m2m_uuv_xzru3m", - "rtn": "Sheet-1", - "cn": "table1_id", - "rcn": "id", - "msg": "New relation added", - "relationType": "bt", - "cstn": "_nc_m2m_uuv_xzru3m_table1_id_foreign" - }, - { - "type": "TABLE_RELATION_ADD", - "tn": "_nc_m2m_uuv_xzru3m", - "rtn": "address", - "cn": "table2_id", - "rcn": "address_id", - "msg": "New relation added", - "relationType": "bt", - "cstn": "_nc_m2m_uuv_xzru3m_table2_id_foreign" - } - ] - } - ] - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Get the meta data difference between NC_DB and external data sources in a given Base" - } - }, - "/api/v1/db/meta/projects/{projectId}/has-empty-or-null-filters": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - } - ], - "get": { - "summary": "List Empty & Null Filter", - "operationId": "project-has-empty-or-null-filters", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["Project"], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": {} - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Check if a project contains empty and null filters. Used in `Show NULL and EMPTY in Filter` in Project Setting.", - "x-internal": true - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - } - ], - "get": { - "summary": "List Table Rows", - "operationId": "db-table-row-list", - "description": "List all table rows in a given table and project", - "tags": ["DB Table Row"], - "parameters": [ - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "fields", - "description": "Which fields to be shown" - }, - { - "schema": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "type": "string" - } - ] - }, - "in": "query", - "name": "sort", - "description": "The result will be sorted based on `sort` query" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where", - "description": "Extra filtering" - }, - { - "schema": { - "type": "integer", - "minimum": 0 - }, - "in": "query", - "name": "offset", - "description": "Offset in rows" - }, - { - "schema": { - "type": "integer", - "minimum": 1 - }, - "in": "query", - "name": "limit", - "description": "Limit in rows" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "sortArrJson", - "description": "Used for multiple sort queries" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "filterArrJson", - "description": "Used for multiple filter queries" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "list": { - "type": "array", - "x-stoplight": { - "id": "g92aqxk869a7o" - }, - "description": "List of data objects", - "items": { - "x-stoplight": { - "id": "rnbt8ubciknfd" - }, - "type": "object" - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated", - "x-stoplight": { - "id": "7f38yyzdg03x5" - }, - "description": "Paginated Info" - } - }, - "required": ["list", "pageInfo"] - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "Id": 1, - "Title": "baz", - "SingleSelect": null, - "Sheet-1 List": [ - { - "Id": 1, - "Title": "baz" - } - ], - "LTAR": [ - { - "Id": 1, - "Title": "baz" - } - ] - }, - { - "Id": 2, - "Title": "foo", - "SingleSelect": "a", - "Sheet-1 List": [ - { - "Id": 2, - "Title": "foo" - } - ], - "LTAR": [ - { - "Id": 2, - "Title": "foo" - } - ] - }, - { - "Id": 3, - "Title": "bar", - "SingleSelect": "b", - "Sheet-1 List": [], - "LTAR": [] - } - ], - "pageInfo": { - "totalRows": 3, - "page": 1, - "pageSize": 25, - "isFirstPage": true, - "isLastPage": true - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - } - }, - "post": { - "summary": "Create Table Row", - "operationId": "db-table-row-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": {} - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Row"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "examples": { - "Example 1": { - "value": { - "Id": 1, - "Title": "foo", - "CreatedAt": "2023-03-11T09:10:53.567Z", - "UpdatedAt": "2023-03-11T09:10:53.567Z" - } - } - } - } - } - }, - "description": "Create a new row in a given table and project.", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/find-one": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - } - ], - "get": { - "summary": "Find One Table Row", - "operationId": "db-table-row-find-one", - "description": "Return the first result of the target Table Row", - "tags": ["DB Table Row"], - "parameters": [ - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "fields" - }, - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "sort" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "examples": { - "Example 1": { - "value": { - "Id": 1, - "Title": "foo", - "CreatedAt": "2023-03-11T09:10:53.567Z", - "UpdatedAt": "2023-03-11T09:10:53.567Z" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - } - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/groupby": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "column_name", - "description": "Column name of the column you want to group by, eg. `column_name=column1`" - } - ], - "get": { - "summary": "Group By Table Row", - "operationId": "db-table-row-group-by", - "description": "Get the result grouped by the given query", - "tags": ["DB Table Row"], - "parameters": [ - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "sort" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where" - }, - { - "schema": { - "type": "integer", - "minimum": 1 - }, - "in": "query", - "name": "limit" - }, - { - "schema": { - "type": "integer", - "minimum": 0 - }, - "in": "query", - "name": "offset" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": {} - } - } - } - } - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/views/{viewName}/group/{columnId}": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string", - "example": "p_tbhl1hnycvhe5l" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string", - "example": "md_5hua2iqloqirhd" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "type": "string", - "example": "vw_mldv0a5mtwh1la" - }, - "name": "viewName", - "in": "path", - "required": true, - "description": "View Name" - }, - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "cl_8iw2o4ejzvdyna", - "type": "string" - }, - "name": "columnId", - "in": "path", - "required": true, - "description": "Unique Column ID" - } - ], - "get": { - "summary": "Table Group by Column", - "operationId": "db-view-row-grouped-data-list", - "description": "Get the grouped data By Column ID. Used in Kanban View.", - "tags": ["DB View Row"], - "parameters": [ - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "fields" - }, - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "sort" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where" - }, - { - "schema": {}, - "in": "query", - "name": "nested", - "description": "Query params for nested data" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": {} - }, - "examples": { - "Example 1": { - "value": [ - { - "key": "a", - "value": { - "list": [ - { - "Id": 2, - "Title": "foo", - "SingleSelect": "a" - } - ], - "pageInfo": { - "totalRows": 1, - "page": 1, - "pageSize": 25, - "isFirstPage": true, - "isLastPage": true - } - } - }, - { - "key": "b", - "value": { - "list": [ - { - "Id": 3, - "Title": "bar", - "SingleSelect": "b" - } - ], - "pageInfo": { - "totalRows": 1, - "page": 1, - "pageSize": 25, - "isFirstPage": true, - "isLastPage": true - } - } - }, - { - "key": null, - "value": { - "list": [ - { - "Id": 1, - "Title": "baz", - "SingleSelect": null - }, - { - "Id": 5, - "Title": "xyz", - "SingleSelect": null - } - ], - "pageInfo": { - "totalRows": 2, - "page": 1, - "pageSize": 25, - "isFirstPage": true, - "isLastPage": true - } - } - } - ] - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - } - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/group/{columnId}": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string", - "example": "p_tbhl1hnycvhe5l" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string", - "example": "md_5hua2iqloqirhd" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "cl_8iw2o4ejzvdyna", - "type": "string" - }, - "name": "columnId", - "in": "path", - "required": true, - "description": "Unique Column ID" - } - ], - "get": { - "summary": "Table Group by Column", - "operationId": "db-table-row-grouped-data-list", - "description": "Get the grouped data By Column ID. Used in Kanban View.", - "tags": ["DB Table Row"], - "parameters": [ - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "fields" - }, - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "sort" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where" - }, - { - "schema": {}, - "in": "query", - "name": "nested", - "description": "Query params for nested data" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": {} - }, - "examples": { - "Example 1": { - "value": [ - { - "key": "a", - "value": { - "list": [ - { - "Id": 2, - "Title": "foo", - "SingleSelect": "a" - } - ], - "pageInfo": { - "totalRows": 1, - "page": 1, - "pageSize": 25, - "isFirstPage": true, - "isLastPage": true - } - } - }, - { - "key": "b", - "value": { - "list": [ - { - "Id": 3, - "Title": "bar", - "SingleSelect": "b" - } - ], - "pageInfo": { - "totalRows": 1, - "page": 1, - "pageSize": 25, - "isFirstPage": true, - "isLastPage": true - } - } - }, - { - "key": null, - "value": { - "list": [ - { - "Id": 1, - "Title": "baz", - "SingleSelect": null - }, - { - "Id": 5, - "Title": "xyz", - "SingleSelect": null - } - ], - "pageInfo": { - "totalRows": 2, - "page": 1, - "pageSize": 25, - "isFirstPage": true, - "isLastPage": true - } - } - } - ] - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - } - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/views/{viewName}": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "type": "string" - }, - "name": "viewName", - "in": "path", - "required": true - } - ], - "get": { - "summary": "List Table View Rows", - "operationId": "db-view-row-list", - "description": "List all table view rows", - "tags": ["DB View Row"], - "parameters": [ - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "fields" - }, - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "sort" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where" - }, - { - "schema": {}, - "in": "query", - "name": "nested", - "description": "Query params for nested data" - }, - { - "schema": { - "type": "number" - }, - "in": "query", - "name": "offset" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "list": { - "type": "array", - "x-stoplight": { - "id": "okd8utzm9xqet" - }, - "description": "List of table view rows", - "items": { - "x-stoplight": { - "id": "j758lsjv53o4q" - }, - "type": "object" - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated", - "x-stoplight": { - "id": "hylgqzgm8yhye" - }, - "description": "Paginated Info" - } - }, - "required": ["list", "pageInfo"] - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "Id": 1, - "Title": "baz", - "SingleSelect": null, - "Sheet-1 List": [ - { - "Id": 1, - "Title": "baz" - } - ], - "LTAR": [ - { - "Id": 1, - "Title": "baz" - } - ] - }, - { - "Id": 2, - "Title": "foo", - "SingleSelect": "a", - "Sheet-1 List": [ - { - "Id": 2, - "Title": "foo" - } - ], - "LTAR": [ - { - "Id": 2, - "Title": "foo" - } - ] - }, - { - "Id": 3, - "Title": "bar", - "SingleSelect": "b", - "Sheet-1 List": [], - "LTAR": [] - } - ], - "pageInfo": { - "totalRows": 3, - "page": 1, - "pageSize": 25, - "isFirstPage": true, - "isLastPage": true - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - } - }, - "post": { - "summary": "Create Table View Row", - "operationId": "db-view-row-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "examples": { - "Example 1": { - "value": { - "Id": 1, - "col1": "foo", - "col2": "bar", - "CreatedAt": "2023-03-11T08:48:25.598Z", - "UpdatedAt": "2023-03-11T08:48:25.598Z" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View Row"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "examples": { - "Example 1": { - "value": { - "col1": "foo", - "col2": "bar" - } - } - } - } - } - }, - "description": "Create a new row in the given Table View" - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/views/{viewName}/find-one": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "type": "string" - }, - "name": "viewName", - "in": "path", - "required": true - } - ], - "get": { - "summary": "Find One Table View Row", - "operationId": "db-view-row-find-one", - "description": "Return the first result of table view rows with the given query", - "tags": ["DB View Row"], - "parameters": [ - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "fields" - }, - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "sort" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where" - }, - { - "schema": {}, - "in": "query", - "name": "nested", - "description": "Query params for nested data" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "examples": { - "Example 1": { - "value": { - "Id": 1, - "Title": "foo", - "CreatedAt": "2023-03-11T09:10:53.567Z", - "UpdatedAt": "2023-03-11T09:10:53.567Z" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - } - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/views/{viewName}/groupby": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "type": "string" - }, - "name": "viewName", - "in": "path", - "required": true - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "column_name", - "description": "Column name of the column you want to group by, eg. `column_name=column1`" - } - ], - "get": { - "summary": "Group By Table View Row", - "operationId": "db-view-row-group-by", - "description": "Get the table view rows groupe by the given query", - "tags": ["DB View Row"], - "parameters": [ - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "sort" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where" - }, - { - "schema": { - "type": "integer", - "minimum": 1 - }, - "in": "query", - "name": "limit" - }, - { - "schema": { - "type": "integer", - "minimum": 0 - }, - "in": "query", - "name": "offset" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": {} - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - } - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/views/{viewName}/count": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "type": "string", - "example": "vw_75neroyqdye94k" - }, - "name": "viewName", - "in": "path", - "required": true, - "description": "View Name" - } - ], - "get": { - "summary": "Count Table View Rows", - "operationId": "db-view-row-count", - "description": "Count how many rows in the given Table View", - "tags": ["DB View Row"], - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where" - }, - { - "schema": {}, - "in": "query", - "name": "nested", - "description": "Query params for nested data" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "count": { - "type": "number", - "x-stoplight": { - "id": "hwq29x70rcipi" - } - } - } - }, - "examples": { - "Example 1": { - "value": { - "count": 25 - } - } - } - } - } - } - } - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/views/{viewName}/{rowId}": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "type": "string", - "example": "vw_75neroyqdye94k" - }, - "name": "viewName", - "in": "path", - "required": true, - "description": "View Name" - }, - { - "schema": { - "example": "1" - }, - "name": "rowId", - "in": "path", - "required": true, - "description": "Unique Row ID" - } - ], - "get": { - "summary": "Get Table View Row", - "operationId": "db-view-row-read", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {} - }, - "examples": { - "Example 1": { - "value": { - "Id": 1, - "Title": "foo", - "CreatedAt": "2023-03-11T09:11:47.437Z", - "UpdatedAt": "2023-03-11T09:11:47.784Z" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Get the target Table View Row", - "tags": ["DB View Row"], - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "patch": { - "summary": "Update Table View Row", - "operationId": "db-view-row-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "examples": { - "Example 1": { - "value": { - "Id": 1, - "Title": "bar", - "CreatedAt": "2023-03-11T09:11:47.437Z", - "UpdatedAt": "2023-03-11T09:20:21.133Z" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View Row"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "examples": { - "Example 1": { - "value": { - "Title": "bar" - } - } - } - } - } - }, - "description": "Update the target Table View Row", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "delete": { - "summary": "Delete Table View Row", - "operationId": "db-view-row-delete", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number" - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB View Row"], - "description": "Delete the target Table View Row", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/views/{viewName}/{rowId}/exist": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "type": "string" - }, - "name": "viewName", - "in": "path", - "required": true - }, - { - "schema": { - "example": "1" - }, - "name": "rowId", - "in": "path", - "required": true, - "description": "Unique Row ID" - } - ], - "get": { - "summary": "Does Table View Row Exist", - "operationId": "db-view-row-exist", - "responses": { - "201": { - "description": "Created", - "content": { - "application/json": { - "schema": { - "type": "number" - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Check row with provided primary key exists or not", - "tags": ["DB View Row"], - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/{rowId}": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "example": "1" - }, - "name": "rowId", - "in": "path", - "required": true, - "description": "Unique Row ID" - } - ], - "get": { - "summary": "Get Table Row", - "operationId": "db-table-row-read", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {} - }, - "examples": { - "Example 1": { - "value": { - "Id": 1, - "Title": "foo", - "CreatedAt": "2023-03-11T09:11:47.437Z", - "UpdatedAt": "2023-03-11T09:11:47.784Z" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Get the Table Row by Row ID", - "tags": ["DB Table Row"], - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "patch": { - "summary": "Update Table Row", - "operationId": "db-table-row-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "examples": { - "Example 1": { - "value": { - "Id": 1, - "Title": "bar", - "CreatedAt": "2023-03-11T09:11:47.437Z", - "UpdatedAt": "2023-03-11T09:20:21.133Z" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Row"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "examples": { - "Example 1": { - "value": { - "Title": "bar" - } - } - } - } - } - }, - "description": "Update the Table Row", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "delete": { - "summary": "Delete Table Row", - "operationId": "db-table-row-delete", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number" - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Row"], - "description": "Delete the Table Row", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/{rowId}/exist": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "example": "1" - }, - "name": "rowId", - "in": "path", - "required": true, - "description": "Unique Row ID" - } - ], - "get": { - "summary": "Does Table Row Exist", - "operationId": "db-table-row-exist", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number" - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "check row with provided primary key exists or not", - "tags": ["DB Table Row"], - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/data/bulk/{orgs}/{projectName}/{tableName}": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - } - ], - "post": { - "summary": "Bulk Insert Table Rows", - "operationId": "db-table-row-bulk-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "description": "List of returned IDs", - "items": { - "x-stoplight": { - "id": "dbkhyd3mnajax" - }, - "type": "object", - "properties": { - "id": { - "type": "string", - "x-stoplight": { - "id": "lnwqjl14f287f" - } - } - } - } - }, - "examples": { - "Example 1": { - "value": [ - { - "id": 1 - }, - { - "id": 2 - } - ] - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Row"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "array", - "description": "List of data objects", - "items": { - "x-stoplight": { - "id": "7u0mp8nzlvysz" - }, - "type": "object" - } - }, - "examples": { - "Example 1": { - "value": [ - { - "Title": "abc" - }, - { - "Title": "def" - } - ] - } - } - } - }, - "description": "" - }, - "description": "Bulk insert table rows in one go.", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "patch": { - "summary": "Bulk Update Table Rows by IDs", - "operationId": "db-table-row-bulk-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "description": "List of returned values. 1 means successful. 0 means failed.", - "items": { - "x-stoplight": { - "id": "ga0xhsahovdt7" - }, - "type": "number" - } - }, - "examples": { - "Example 1": { - "value": [1, 1] - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Row"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "array", - "description": "List of data objects", - "items": { - "x-stoplight": { - "id": "q2xtbf29i1s5n" - }, - "type": "object" - } - }, - "examples": { - "Example 1": { - "value": [ - { - "Id": "1", - "Title": "123" - }, - { - "Id": "2", - "Title": "456" - } - ] - } - } - } - } - }, - "description": "Bulk Update Table Rows by given IDs", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "delete": { - "summary": "Bulk Delete Table Rows by IDs", - "operationId": "db-table-row-bulk-delete", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "x-stoplight": { - "id": "b9o9o2r6ipho9" - }, - "type": "number" - } - }, - "examples": { - "Example 1": { - "value": [1, 1] - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Row"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "x-stoplight": { - "id": "sd8udhhjnqiay" - }, - "type": "object" - } - }, - "examples": { - "Example 1": { - "value": [ - { - "Id": "1" - }, - { - "Id": "2" - } - ] - } - } - } - }, - "description": "" - }, - "description": "Bulk Delete Table Rows by given IDs", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/data/bulk/{orgs}/{projectName}/{tableName}/all": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where" - } - ], - "patch": { - "summary": "Bulk Update Table Rows with Conditions", - "operationId": "db-table-row-bulk-update-all", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": {}, - "examples": { - "Example 1": { - "value": [ - { - "Id": "1" - }, - { - "Id": "2" - } - ] - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Row"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "examples": { - "Example 1": { - "value": { - "Title": "foo" - } - } - } - } - } - }, - "description": "Bulk Update all Table Rows if the condition is true", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "delete": { - "summary": "Bulk Delete Table Rows with Conditions", - "operationId": "db-table-row-bulk-delete-all", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "x-stoplight": { - "id": "9gcl3ok7is3y0" - }, - "type": "object" - } - }, - "examples": { - "Example 1": { - "value": [1, 1] - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Row"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "examples": { - "Example 1": { - "value": { - "Title": "foo" - } - } - } - } - } - }, - "description": "Bulk Delete all Table Rows if the condition is true", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/views/{viewName}/export/{type}": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "type": "string" - }, - "name": "viewName", - "in": "path", - "required": true - }, - { - "schema": { - "type": "string", - "enum": ["csv", "excel"] - }, - "name": "type", - "in": "path", - "required": true - } - ], - "get": { - "summary": "Export Table View Rows", - "operationId": "db-view-row-export", - "description": "Export Table View Rows by CSV or Excel", - "tags": ["DB View Row"], - "wrapped": true, - "responses": { - "200": { - "description": "OK", - "content": { - "application/octet-stream": { - "schema": {} - } - }, - "headers": { - "nc-export-offset": { - "schema": { - "type": "integer" - }, - "description": "The starting offset of the next set of rows" - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/export/{type}": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "type": "string", - "enum": ["csv", "excel"] - }, - "name": "type", - "in": "path", - "required": true - } - ], - "get": { - "summary": "Export Table View Rows", - "operationId": "db-table-row-csv-export", - "description": "Export Table View Rows by CSV or Excel", - "tags": ["DB Table Row"], - "wrapped": true, - "responses": { - "200": { - "description": "OK", - "content": { - "application/octet-stream": { - "schema": {} - } - }, - "headers": { - "nc-export-offset": { - "schema": { - "type": "integer" - }, - "description": "The starting offset of the next set of rows" - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/{rowId}/{relationType}/{columnName}": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "example": "1" - }, - "name": "rowId", - "in": "path", - "required": true, - "description": "Unique Row ID" - }, - { - "schema": { - "type": "string", - "enum": ["mm", "hm", "bt"] - }, - "name": "relationType", - "in": "path", - "required": true, - "description": "Relation Type" - }, - { - "schema": { - "type": "string" - }, - "name": "columnName", - "in": "path", - "required": true, - "description": "Column Name" - } - ], - "get": { - "summary": "List Nested Relations Rows", - "operationId": "db-table-row-nested-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": {} - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Row"], - "parameters": [ - { - "schema": { - "type": "integer", - "minimum": 1 - }, - "in": "query", - "name": "limit" - }, - { - "schema": { - "type": "integer", - "minimum": 0 - }, - "in": "query", - "name": "offset" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "description": "List all nested relations rows" - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/{rowId}/{relationType}/{columnName}/{refRowId}": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "example": "1" - }, - "name": "rowId", - "in": "path", - "required": true, - "description": "Unique Row ID" - }, - { - "schema": { - "type": "string", - "enum": ["mm", "hm", "bt"] - }, - "name": "relationType", - "in": "path", - "required": true - }, - { - "schema": { - "type": "string" - }, - "name": "columnName", - "in": "path", - "required": true - }, - { - "schema": { - "type": "string" - }, - "name": "refRowId", - "in": "path", - "required": true - } - ], - "post": { - "summary": "Create Nested Relations Row", - "operationId": "db-table-row-nested-add", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "m6jox00hxgd6s" - }, - "example": "The relation data has been created successfully" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "The relation data has been created successfully" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Row"], - "parameters": [ - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "fields", - "description": "Which fields to be shown" - }, - { - "schema": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "type": "string" - } - ] - }, - "in": "query", - "name": "sort", - "description": "The result will be sorted based on `sort` query" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where", - "description": "Extra filtering" - }, - { - "schema": { - "type": "integer", - "minimum": 0 - }, - "in": "query", - "name": "offset", - "description": "Offset in rows" - }, - { - "schema": { - "type": "integer", - "minimum": 1 - }, - "in": "query", - "name": "limit", - "description": "Limit in rows" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "sortArrJson", - "description": "Used for multiple sort queries" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "filterArrJson", - "description": "Used for multiple filter queries" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "description": "Create a new nested relations row" - }, - "delete": { - "summary": "Delete Nested Relations Row", - "operationId": "db-table-row-nested-remove", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "vo3x8xf3j2xlb" - }, - "example": "The relation data has been deleted successfully" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "The relation data has been deleted successfully" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Row"], - "description": "Delete a new nested relations row", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/data/{orgs}/{projectName}/{tableName}/{rowId}/{relationType}/{columnName}/exclude": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "orgs", - "in": "path", - "required": true, - "description": "Organisation Name. Currently `noco` will be used." - }, - { - "schema": { - "type": "string" - }, - "name": "projectName", - "in": "path", - "required": true, - "description": "Project Name" - }, - { - "schema": { - "type": "string" - }, - "name": "tableName", - "in": "path", - "required": true, - "description": "Table Name" - }, - { - "schema": { - "example": "1" - }, - "name": "rowId", - "in": "path", - "required": true, - "description": "Unique Row ID" - }, - { - "schema": { - "type": "string", - "enum": ["mm", "hm", "bt"] - }, - "name": "relationType", - "in": "path", - "required": true - }, - { - "schema": { - "type": "string" - }, - "name": "columnName", - "in": "path", - "required": true - } - ], - "get": { - "summary": "Referenced Table Rows Excluding Current Record's Children / Parent", - "operationId": "db-table-row-nested-children-excluded-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": {} - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Row"], - "parameters": [ - { - "schema": { - "type": "integer", - "minimum": 1 - }, - "in": "query", - "name": "limit" - }, - { - "schema": { - "type": "integer", - "minimum": 0 - }, - "in": "query", - "name": "offset" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "description": "Get the table rows but exculding the current record's children and parent" - } - }, - "/api/v1/db/public/shared-view/{sharedViewUuid}/group/{columnId}": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "24a6d0bb-e45d-4b1a-bfef-f492d870de9f" - }, - "name": "sharedViewUuid", - "in": "path", - "required": true, - "description": "Shared View UUID" - }, - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "cl_8iw2o4ejzvdyna", - "type": "string" - }, - "name": "columnId", - "in": "path", - "required": true, - "description": "Unique Column ID" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "xc-password", - "description": "Shared view password" - } - ], - "get": { - "summary": "List Shared View Grouped Data", - "operationId": "public-grouped-data-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "x-stoplight": { - "id": "bldcv1pwuri5s" - }, - "type": "object", - "properties": { - "key": { - "type": "string", - "x-stoplight": { - "id": "n0ujmkbyhgsxo" - }, - "description": "The Grouped Key" - }, - "value": { - "type": "object", - "x-stoplight": { - "id": "0xsi3jvwn7duo" - }, - "description": "the paginated result of the given key", - "required": ["list", "pageInfo"], - "properties": { - "list": { - "type": "array", - "x-stoplight": { - "id": "jw8dmo16txbjv" - }, - "description": "List of the target data", - "items": { - "x-stoplight": { - "id": "xcu8vxmf5ygyi" - }, - "type": "object" - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated", - "x-stoplight": { - "id": "1gsbgwi9bg8s5" - }, - "description": "Paginated Info" - } - } - } - }, - "required": ["key", "value"] - } - }, - "examples": { - "Example 1": { - "value": [ - { - "key": "a", - "value": { - "list": [ - { - "Id": 2, - "Title": "foo", - "s": "a" - } - ], - "pageInfo": { - "totalRows": 1, - "page": 1, - "pageSize": 25, - "isFirstPage": true, - "isLastPage": true - } - } - }, - { - "key": "b", - "value": { - "list": [ - { - "Id": 3, - "Title": "bar", - "s": "b" - } - ], - "pageInfo": { - "totalRows": 1, - "page": 1, - "pageSize": 25, - "isFirstPage": true, - "isLastPage": true - } - } - }, - { - "key": null, - "value": { - "list": [ - { - "Id": 1, - "Title": "baz", - "s": null - } - ], - "pageInfo": { - "totalRows": 1, - "page": 1, - "pageSize": 25, - "isFirstPage": true, - "isLastPage": true - } - } - } - ] - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Public"], - "parameters": [ - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "fields", - "description": "Which fields to be shown" - }, - { - "schema": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "type": "string" - } - ] - }, - "in": "query", - "name": "sort", - "description": "The result will be sorted based on `sort` query" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where", - "description": "Extra filtering" - }, - { - "schema": { - "type": "integer", - "minimum": 0 - }, - "in": "query", - "name": "offset", - "description": "Offset in rows" - }, - { - "schema": { - "type": "integer", - "minimum": 1 - }, - "in": "query", - "name": "limit", - "description": "Limit in rows" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "sortArrJson", - "description": "Used for multiple sort queries" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "filterArrJson", - "description": "Used for multiple filter queries" - } - ], - "description": "List Shared View Grouped Data" - } - }, - "/api/v1/db/public/shared-view/{sharedViewUuid}/rows": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "24a6d0bb-e45d-4b1a-bfef-f492d870de9f" - }, - "name": "sharedViewUuid", - "in": "path", - "required": true, - "description": "Shared View UUID" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "xc-password", - "description": "Shared view password" - } - ], - "get": { - "summary": "List Shared View Rows", - "operationId": "public-data-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SharedViewList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:46:31", - "fk_model_id": "md_mhs9z4r2ak98x0", - "id": "vw_lg052cnc1c26kf", - "is_default": 1, - "lock_type": "collaborative", - "meta": {}, - "order": 1, - "password": null, - "project_id": "p_xm3thidrblw4n7", - "show": 1, - "show_system_fields": null, - "title": "Sheet-1", - "type": 3, - "updated_at": "2023-03-02 17:46:31", - "uuid": null, - "view": { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:46:31", - "fk_view_id": "vw_lg052cnc1c26kf", - "meta": null, - "project_id": "p_xm3thidrblw4n7", - "row_height": null, - "updated_at": "2023-03-02 17:46:31", - "uuid": null - } - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Public"], - "parameters": [ - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "fields", - "description": "Which fields to be shown" - }, - { - "schema": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "type": "string" - } - ] - }, - "in": "query", - "name": "sort", - "description": "The result will be sorted based on `sort` query" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where", - "description": "Extra filtering" - }, - { - "schema": { - "type": "integer", - "minimum": 0 - }, - "in": "query", - "name": "offset", - "description": "Offset in rows" - }, - { - "schema": { - "type": "integer", - "minimum": 1 - }, - "in": "query", - "name": "limit", - "description": "Limit in rows" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "sortArrJson", - "description": "Used for multiple sort queries" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "filterArrJson", - "description": "Used for multiple filter queries" - } - ], - "description": "List all shared view rows" - }, - "post": { - "summary": "Create Share View Row", - "operationId": "public-data-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "examples": { - "Example 1": { - "value": { - "Id": 1, - "col1": "foo", - "col2": "bar", - "CreatedAt": "2023-03-11T08:48:25.598Z", - "UpdatedAt": "2023-03-11T08:48:25.598Z" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "multipart/form-data": {} - }, - "description": "" - }, - "tags": ["Public"], - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "xc-password", - "description": "Shared view password" - } - ], - "description": "Create a new row for the target shared view" - } - }, - "/api/v1/db/public/shared-view/{sharedViewUuid}/rows/{rowId}/{relationType}/{columnName}": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "24a6d0bb-e45d-4b1a-bfef-f492d870de9f" - }, - "name": "sharedViewUuid", - "in": "path", - "required": true, - "description": "Shared View UUID" - }, - { - "schema": { - "example": "1" - }, - "name": "rowId", - "in": "path", - "required": true, - "description": "Unique Row ID" - }, - { - "schema": { - "type": "string", - "enum": ["mm", "hm", "bt"] - }, - "name": "relationType", - "in": "path", - "required": true, - "description": "Relation Type" - }, - { - "schema": { - "type": "string" - }, - "name": "columnName", - "in": "path", - "required": true, - "description": "Column Name" - } - ], - "get": { - "summary": "List Nested List Data", - "operationId": "public-data-nested-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "list": { - "type": "array", - "x-stoplight": { - "id": "gvblksjzjfyg7" - }, - "description": "List of data objects", - "items": { - "x-stoplight": { - "id": "8assgoc1vtcs9" - }, - "type": "object" - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated", - "x-stoplight": { - "id": "if546w1yuo6fw" - }, - "description": "Paginated info" - } - }, - "required": ["list", "pageInfo"] - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "Id": 1, - "Title": "foo", - "CreatedAt": "2023-03-11T08:41:41.356Z", - "UpdatedAt": "2023-03-11T08:41:41.356Z" - }, - { - "Id": 2, - "Title": "bar", - "CreatedAt": "2023-03-11T08:41:45.330Z", - "UpdatedAt": "2023-03-11T08:41:45.330Z" - }, - { - "Id": 3, - "Title": "baz", - "CreatedAt": "2023-03-11T08:48:25.598Z", - "UpdatedAt": "2023-03-11T08:48:25.598Z" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "pageSize": 1, - "sort": "string", - "totalRows": 3 - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Public"], - "parameters": [ - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "fields", - "description": "Which fields to be shown" - }, - { - "schema": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "type": "string" - } - ] - }, - "in": "query", - "name": "sort", - "description": "The result will be sorted based on `sort` query" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where", - "description": "Extra filtering" - }, - { - "schema": { - "type": "integer", - "minimum": 0 - }, - "in": "query", - "name": "offset", - "description": "Offset in rows" - }, - { - "schema": { - "type": "integer", - "minimum": 1 - }, - "in": "query", - "name": "limit", - "description": "Limit in rows" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "sortArrJson", - "description": "Used for multiple sort queries" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "filterArrJson", - "description": "Used for multiple filter queries" - } - ], - "description": "List all nested list data in a given shared view" - } - }, - "/api/v1/db/public/shared-view/{sharedViewUuid}/rows/export/{type}": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "76d44b86-bc65-4500-8956-ab512c80ab25" - }, - "name": "sharedViewUuid", - "in": "path", - "required": true, - "description": "Shared View UUID" - }, - { - "schema": { - "type": "string", - "enum": ["csv", "excel"], - "example": "csv" - }, - "name": "type", - "in": "path", - "required": true, - "description": "Export Type" - } - ], - "get": { - "summary": "Export Rows in Share View", - "operationId": "public-csv-export", - "description": "Export all rows in Share View in a CSV / Excel Format", - "wrapped": true, - "responses": { - "200": { - "description": "OK", - "content": { - "application/octet-stream": { - "schema": {} - } - }, - "headers": { - "nc-export-offset": { - "schema": { - "type": "integer" - }, - "description": "The starting offset of the next set of rows" - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Public"] - } - }, - "/api/v1/db/public/shared-view/{sharedViewUuid}/nested/{columnName}": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "24a6d0bb-e45d-4b1a-bfef-f492d870de9f" - }, - "name": "sharedViewUuid", - "in": "path", - "required": true, - "description": "Shared View UUID" - }, - { - "schema": { - "type": "string" - }, - "name": "columnName", - "in": "path", - "required": true, - "description": "Column Name" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "xc-password", - "description": "Shared view password" - } - ], - "get": { - "summary": "List Nested Data Relation", - "operationId": "public-data-relation-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": {} - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "parameters": [ - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "fields", - "description": "Which fields to be shown" - }, - { - "schema": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "type": "string" - } - ] - }, - "in": "query", - "name": "sort", - "description": "The result will be sorted based on `sort` query" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "where", - "description": "Extra filtering" - }, - { - "schema": { - "type": "integer", - "minimum": 0 - }, - "in": "query", - "name": "offset", - "description": "Offset in rows" - }, - { - "schema": { - "type": "integer", - "minimum": 1 - }, - "in": "query", - "name": "limit", - "description": "Limit in rows" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "sortArrJson", - "description": "Used for multiple sort queries" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "filterArrJson", - "description": "Used for multiple filter queries" - } - ], - "tags": ["Public"], - "description": "List Nested Data Relation" - } - }, - "/api/v1/db/public/shared-base/{sharedBaseUuid}/meta": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "24a6d0bb-e45d-4b1a-bfef-f492d870de9f" - }, - "name": "sharedBaseUuid", - "in": "path", - "required": true, - "description": "Shared Base UUID" - } - ], - "get": { - "summary": "Get Share Base Meta", - "operationId": "public-shared-base-get", - "description": "Get Share Base Meta", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "project_id": { - "type": "string", - "description": "Project ID" - } - } - }, - "examples": { - "Example 1": { - "value": { - "project_id": "p_63b4q0qengen1x" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Public"] - } - }, - "/api/v1/db/public/shared-view/{sharedViewUuid}/meta": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "24a6d0bb-e45d-4b1a-bfef-f492d870de9f" - }, - "name": "sharedViewUuid", - "in": "path", - "required": true, - "description": "Shared View UUID" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "xc-password", - "description": "Shared view password" - } - ], - "get": { - "summary": "Get Share View Meta", - "operationId": "public-shared-view-meta-get", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/View" - }, - { - "type": "object", - "properties": { - "relatedMetas": {}, - "client": { - "type": "string" - }, - "base_id": { - "type": "string" - }, - "columns": { - "allOf": [ - { - "anyOf": [ - { - "$ref": "#/components/schemas/GridColumn" - }, - { - "$ref": "#/components/schemas/FormColumn" - }, - { - "$ref": "#/components/schemas/GalleryColumn" - } - ] - }, - { - "$ref": "#/components/schemas/Column" - } - ] - }, - "model": { - "$ref": "#/components/schemas/Table" - } - } - }, - { - "type": "object", - "properties": { - "view": { - "anyOf": [ - { - "$ref": "#/components/schemas/Form" - }, - { - "$ref": "#/components/schemas/Grid" - }, - { - "$ref": "#/components/schemas/Gallery" - } - ] - } - } - } - ] - } - }, - "application/xml": { - "schema": {} - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Public"], - "description": "Get Share View Meta" - } - }, - "/api/v1/db/meta/audits/comments": { - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "get": { - "summary": "List Comments in Audit", - "operationId": "utils-comment-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "list": { - "x-stoplight": { - "id": "5zto1xohsngbu" - }, - "type": "array", - "items": { - "$ref": "#/components/schemas/Audit", - "x-stoplight": { - "id": "d22zkup0c0l80" - } - } - } - }, - "required": ["list"] - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "id": "adt_3sii7erfwrlegb", - "user": "w@nocodb.com", - "ip": null, - "base_id": null, - "project_id": "p_63b4q0qengen1x", - "fk_model_id": "md_5mipbdg6ketmv8", - "row_id": "1", - "op_type": "COMMENT", - "op_sub_type": null, - "status": null, - "description": "bar", - "details": null, - "created_at": "2023-03-13T09:39:14.225Z", - "updated_at": "2023-03-13T09:39:14.225Z" - }, - { - "id": "adt_fezs668qbxj8gc", - "user": "w@nocodb.com", - "ip": null, - "base_id": null, - "project_id": "p_63b4q0qengen1x", - "fk_model_id": "md_5mipbdg6ketmv8", - "row_id": "1", - "op_type": "COMMENT", - "op_sub_type": null, - "status": null, - "description": "foo", - "details": null, - "created_at": "2023-03-13T09:39:13.321Z", - "updated_at": "2023-03-13T09:39:13.321Z" - } - ] - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "List all comments", - "parameters": [ - { - "schema": { - "type": "string", - "example": "10" - }, - "in": "query", - "name": "row_id", - "required": true, - "description": "Row ID" - }, - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "md_c6csq89tl37jm5" - }, - "in": "query", - "name": "fk_model_id", - "required": true, - "description": "Foreign Key to Model" - }, - { - "schema": { - "type": "boolean", - "example": true - }, - "in": "query", - "name": "comments_only", - "description": "Is showing comments only?" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["Utils"] - }, - "post": { - "summary": "Comment Rows", - "operationId": "utils-comment-row", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Audit" - }, - "examples": { - "Example 1": { - "value": { - "user": "w@nocodb.com", - "row_id": "1", - "fk_model_id": "md_5mipbdg6ketmv8", - "op_type": "COMMENT", - "description": "qq", - "project_id": "p_63b4q0qengen1x", - "id": "adt_vx58jpp0loo8qy" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CommentReq" - }, - "examples": { - "Example 1": { - "value": { - "description": "This is the comment for the row", - "fk_model_id": "md_ehn5izr99m7d45", - "row_id": "3" - } - } - } - } - } - }, - "tags": ["Utils"], - "description": "Create a new comment in a row. Logged in Audit.", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/audits/{auditId}/comment": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "adt_zlskd6rlf3liay" - }, - "name": "auditId", - "in": "path", - "required": true, - "description": "Audit ID" - }, - { - "name": "xc-auth", - "in": "header", - "required": false, - "schema": { - "type": "string" - }, - "description": "Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN." - } - ], - "patch": { - "summary": "Update Comment in Audit", - "operationId": "utils-comment-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number", - "example": 1 - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - } - }, - "tags": ["Utils"], - "description": "Update comment in Audit", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CommentUpdateReq" - }, - "examples": { - "Example 1": { - "value": { - "description": "This is the comment for the row" - } - } - } - } - } - } - } - }, - "/api/v1/db/meta/audits/comments/count": { - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "get": { - "summary": "Count Comments", - "operationId": "utils-comment-count", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "x-stoplight": { - "id": "ziwcy4va5r1ao" - }, - "type": "object", - "properties": { - "count": { - "type": "string", - "x-stoplight": { - "id": "5r91gkxmaiyv4" - }, - "description": "The number of comments", - "example": "4" - }, - "row_id": { - "type": "string", - "x-stoplight": { - "id": "08sgorhq172sm" - }, - "description": "Row ID", - "example": "1" - } - }, - "required": ["count", "row_id"] - } - }, - "examples": { - "Example 1": { - "value": [ - { - "count": "4", - "row_id": "1" - } - ] - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Return the number of comments in the given query.", - "parameters": [ - { - "in": "query", - "name": "ids", - "required": true, - "description": "Comment IDs" - }, - { - "schema": { - "$ref": "#/components/schemas/Id" - }, - "in": "query", - "name": "fk_model_id", - "required": true, - "description": "Foreign Key to Model" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["Utils"] - } - }, - "/api/v1/db/meta/projects/{projectId}/audits": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - } - ], - "get": { - "summary": "List Audits in Project", - "operationId": "project-audit-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "list": { - "type": "array", - "uniqueItems": true, - "minItems": 1, - "items": { - "$ref": "#/components/schemas/Audit" - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated" - } - }, - "required": ["list", "pageInfo"] - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "List all audit data in the given project", - "parameters": [ - { - "schema": { - "type": "integer", - "minimum": 0 - }, - "in": "query", - "name": "offset" - }, - { - "schema": { - "type": "integer", - "maximum": 1 - }, - "in": "query", - "name": "limit" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["Project"] - } - }, - "/api/v1/db/meta/audits/rows/{rowId}/update": { - "parameters": [ - { - "schema": { - "example": "1" - }, - "name": "rowId", - "in": "path", - "required": true, - "description": "Unique Row ID" - } - ], - "post": { - "summary": "Update Audit Row", - "operationId": "utils-audit-row-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Audit" - }, - "examples": { - "Example 1": { - "value": { - "user": "w@nocodb.com", - "row_id": "1", - "fk_model_id": "md_5mipbdg6ketmv8", - "op_type": "COMMENT", - "description": "Table Sheet-1 : field Column A got changed from foo to bar", - "project_id": "p_63b4q0qengen1x", - "id": "adt_vx58jpp0loo8qy" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Utils"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AuditRowUpdateReq" - }, - "examples": { - "Example 1": { - "value": { - "column_name": "baz", - "fk_model_id": "md_ehn5izr99m7d45", - "row_id": "1", - "prev_value": "foo", - "value": "bar" - } - } - } - } - } - }, - "description": "Update Audit Row", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/tables/{tableId}/hooks": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "md_w9gpnaousnfss1", - "type": "string" - }, - "name": "tableId", - "in": "path", - "required": true, - "description": "Unique Table ID" - } - ], - "get": { - "summary": "List Table Hooks", - "operationId": "db-table-webhook-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HookList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "active": 0, - "async": 0, - "description": "This is my hook description", - "env": "all", - "event": "after", - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "string", - "notification": "{\"type\":\"URL\",\"payload\":{\"method\":\"POST\",\"body\":\"{{ json data }}\",\"headers\":[{}],\"parameters\":[{}],\"auth\":\"\",\"path\":\"http://example.com\"}}", - "null": null, - "operation": "insert", - "retries": 10, - "retry_interval": 60000, - "timeout": 60000, - "title": "My Webhook" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "List all hook records in the given Table", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["DB Table Webhook"] - }, - "post": { - "summary": "Create Table Hook", - "operationId": "db-table-webhook-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Hook" - }, - "examples": { - "Example 1": { - "value": { - "active": 0, - "async": 0, - "description": "This is my hook description", - "env": "all", - "event": "after", - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "string", - "notification": "{\"type\":\"URL\",\"payload\":{\"method\":\"POST\",\"body\":\"{{ json data }}\",\"headers\":[{}],\"parameters\":[{}],\"auth\":\"\",\"path\":\"http://example.com\"}}", - "null": null, - "operation": "insert", - "retries": 10, - "retry_interval": 60000, - "timeout": 60000, - "title": "My Webhook" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Create a hook in the given table", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HookReq" - }, - "examples": { - "Example 1": { - "value": { - "active": 0, - "async": 0, - "description": "This is my hook description", - "env": "all", - "event": "after", - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "string", - "notification": "{\"type\":\"URL\",\"payload\":{\"method\":\"POST\",\"body\":\"{{ json data }}\",\"headers\":[{}],\"parameters\":[{}],\"auth\":\"\",\"path\":\"http://example.com\"}}", - "null": null, - "operation": "insert", - "retries": 10, - "retry_interval": 60000, - "timeout": 60000, - "title": "My Webhook", - "condition": false - } - } - } - } - } - }, - "tags": ["DB Table Webhook"] - } - }, - "/api/v1/db/meta/tables/{tableId}/hooks/test": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "md_w9gpnaousnfss1", - "type": "string" - }, - "name": "tableId", - "in": "path", - "required": true, - "description": "Unique Table ID" - } - ], - "post": { - "summary": "Test Hook", - "operationId": "db-table-webhook-test", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "l5k90tzuvvv1g" - }, - "example": "The hook has been tested successfully" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "The hook has been tested successfully" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Webhook"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HookTestReq" - }, - "examples": { - "Example 1": { - "value": { - "hook": { - "active": 0, - "async": 0, - "description": "This is my hook description", - "env": "all", - "event": "after", - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "string", - "notification": "{\"type\":\"URL\",\"payload\":{\"method\":\"POST\",\"body\":\"{{ json data }}\",\"headers\":[{}],\"parameters\":[{}],\"auth\":\"\",\"path\":\"http://example.com\"}}", - "null": null, - "operation": "insert", - "retries": 10, - "retry_interval": 60000, - "timeout": 60000, - "title": "My Webhook" - }, - "payload": { - "data": { - "Id": 1, - "Title": "Sample Text", - "CreatedAt": "2023-03-03T10:03:06.484Z", - "UpdatedAt": "2023-03-03T10:03:06.484Z", - "attachment": [ - { - "url": "https://nocodb.com/dummy.png", - "title": "image.png", - "mimetype": "image/png", - "size": 0 - } - ], - "f": "Sample Output" - } - } - } - } - } - } - } - }, - "description": "Test the hook in the given Table", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/tables/{tableId}/hooks/samplePayload/{operation}/{version}": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "md_w9gpnaousnfss1", - "type": "string" - }, - "name": "tableId", - "in": "path", - "required": true, - "description": "Unique Table ID" - }, - { - "schema": { - "type": "string", - "enum": [ - "insert", - "update", - "delete", - "bulkInsert", - "bulkUpdate", - "bulkDelete" - ] - }, - "name": "operation", - "in": "path", - "required": true, - "description": "Hook Operation" - }, - { - "schema": { - "type": "string", - "enum": ["v1", "v2"] - }, - "name": "version", - "in": "path", - "required": true, - "description": "Hook Version" - } - ], - "get": { - "summary": "Get Sample Hook Payload", - "operationId": "db-table-webhook-sample-payload-get", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "data": { - "type": "object", - "x-stoplight": { - "id": "qifsikf69hqbl" - }, - "description": "Sample Payload Data" - } - } - }, - "examples": { - "Example 1": { - "value": { - "data": { - "Id": 1, - "Title": "Sample Text", - "CreatedAt": "2023-03-13T04:59:49.363Z", - "UpdatedAt": "2023-03-13T04:59:49.363Z" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Get the sample hook payload", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["DB Table Webhook"] - } - }, - "/api/v1/db/meta/hooks/{hookId}": { - "parameters": [ - { - "schema": { - "type": "string", - "example": "hk_0063k4o1frnxbr" - }, - "name": "hookId", - "in": "path", - "required": true, - "description": "Unique Hook ID" - } - ], - "patch": { - "summary": "Update Hook", - "operationId": "db-table-webhook-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Hook" - }, - "examples": { - "Example 1": { - "value": { - "active": 0, - "async": 0, - "description": "This is my hook description", - "env": "all", - "event": "after", - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "string", - "notification": "{\"type\":\"URL\",\"payload\":{\"method\":\"POST\",\"body\":\"{{ json data }}\",\"headers\":[{}],\"parameters\":[{}],\"auth\":\"\",\"path\":\"http://example.com\"}}", - "null": null, - "operation": "insert", - "retries": 10, - "retry_interval": 60000, - "timeout": 60000, - "title": "My Webhook" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Webhook"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Hook" - }, - "examples": { - "Example 1": { - "value": { - "active": 0, - "async": 0, - "description": "This is my hook description", - "env": "all", - "event": "after", - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "string", - "notification": "{\"type\":\"URL\",\"payload\":{\"method\":\"POST\",\"body\":\"{{ json data }}\",\"headers\":[{}],\"parameters\":[{}],\"auth\":\"\",\"path\":\"http://example.com\"}}", - "null": null, - "operation": "insert", - "retries": 10, - "retry_interval": 60000, - "timeout": 60000, - "title": "My Webhook" - } - } - } - } - } - }, - "description": "Update the exsiting hook by its ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "delete": { - "summary": "Delete Hook", - "operationId": "db-table-webhook-delete", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "boolean" - }, - "examples": { - "Example 1": { - "value": true - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["DB Table Webhook"], - "description": "Delete the exsiting hook by its ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/plugins": { - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "get": { - "summary": "List Plugins", - "operationId": "plugin-list", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "list": { - "type": "array", - "uniqueItems": true, - "minItems": 1, - "items": { - "$ref": "#/components/schemas/Plugin" - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "List all plugins", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["Plugin"] - } - }, - "/api/v1/db/meta/plugins/{pluginTitle}/status": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "pluginTitle", - "in": "path", - "required": true, - "description": "Plugin Title" - } - ], - "get": { - "summary": "Get Plugin Status", - "operationId": "plugin-status", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "boolean" - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Check plugin is active or not", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["Plugin"], - "x-internal": false - } - }, - "/api/v1/db/meta/plugins/test": { - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "post": { - "summary": "Test Plugin", - "operationId": "plugin-test", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": {} - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Test if the plugin is working with the given configurations", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "tags": ["Plugin"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PluginTestReq" - }, - "examples": { - "Example 1": { - "value": { - "title": "Plugin Foo", - "input": "{\"bucket\":\"my-bucket\",\"region\":\"us-west-004\",\"access_key\":\"redacted\",\"access_secret\":\"redacted\"}", - "category": "Email" - } - } - } - } - } - } - } - }, - "/api/v1/db/meta/plugins/{pluginId}": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "pluginId", - "in": "path", - "required": true, - "description": "Plugin ID" - } - ], - "patch": { - "summary": "Update Plugin", - "operationId": "plugin-update", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": {} - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Plugin"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PluginReq" - } - } - } - }, - "description": "Update the plugin data by ID", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "x-internal": false - }, - "get": { - "summary": "Get Plugin", - "operationId": "plugin-read", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Plugin" - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Plugin"], - "description": "Get the plugin data by ID", - "x-internal": false - } - }, - "/api/v1/db/meta/connection/test": { - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "post": { - "summary": "Test DB Connection", - "operationId": "utils-test-connection", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "code": { - "type": "number" - }, - "message": { - "type": "string" - }, - "data": { - "type": "object", - "x-stoplight": { - "id": "6orbk04w97ien" - } - } - } - }, - "examples": { - "Example 1": { - "value": { - "code": 0, - "message": "", - "data": {} - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Utils"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "x-examples": { - "Example 1": { - "client": "mysql2", - "connection": { - "host": "localhost", - "port": "3306", - "user": "root", - "password": "password", - "database": null - } - } - }, - "properties": { - "client": { - "description": "DB Type", - "enum": [ - "mssql", - "mysql", - "mysql2", - "oracledb", - "pg", - "snowflake", - "sqlite3" - ], - "example": "mysql2", - "type": "string" - }, - "connection": { - "type": "object", - "properties": { - "host": { - "type": "string" - }, - "port": { - "type": "string" - }, - "user": { - "type": "string" - }, - "password": { - "type": "string" - }, - "database": { - "$ref": "#/components/schemas/StringOrNull" - } - } - } - } - }, - "examples": { - "Example 1": { - "value": { - "client": "mysql2", - "connection": { - "host": "localhost", - "port": "3306", - "user": "root", - "password": "password", - "database": null - } - } - } - } - } - } - }, - "description": "Test the DB Connection", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/url_to_config": { - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "post": { - "summary": "Convert JDBC URL to Config", - "operationId": "utils-url-to-config", - "tags": ["Utils"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "url": { - "type": "string", - "x-stoplight": { - "id": "fgdbmcjjtkky5" - }, - "description": "JDBC URL", - "example": "jdbc:mysql://username:password@localhost:3306/sakila" - } - } - }, - "examples": { - "Example 1": { - "value": { - "url": "jdbc:mysql://username:password@localhost:3306/sakila" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "x-examples": { - "Example 1": { - "client": "mysql2", - "connection": { - "user": "username", - "password": "password", - "database": "sakila", - "host": "localhost", - "port": "3306" - } - } - }, - "properties": { - "client": { - "description": "DB Type", - "enum": [ - "mssql", - "mysql", - "mysql2", - "oracledb", - "pg", - "snowflake", - "sqlite3" - ], - "example": "mysql2", - "type": "string" - }, - "connection": { - "type": "object", - "description": "Connection Config", - "properties": { - "user": { - "type": "string", - "description": "DB User" - }, - "password": { - "type": "string", - "description": "DB Password" - }, - "database": { - "type": "string", - "description": "DB Name" - }, - "host": { - "type": "string", - "description": "DB Host" - }, - "port": { - "type": "string", - "description": "DB Host" - } - } - } - } - }, - "examples": { - "Example 1": { - "value": { - "client": "mysql2", - "connection": { - "user": "username", - "password": "password", - "database": "sakila", - "host": "localhost", - "port": "3306" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Extract XC URL From JDBC and parse to connection config", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/nocodb/info": { - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "get": { - "summary": "Get App Info", - "operationId": "utils-app-info", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "x-examples": { - "Example 1": { - "authType": "jwt", - "projectHasAdmin": true, - "firstUser": false, - "type": "rest", - "googleAuthEnabled": false, - "githubAuthEnabled": false, - "oneClick": false, - "connectToExternalDB": true, - "version": "0.105.3", - "defaultLimit": 25, - "ncMin": false, - "teleEnabled": false, - "auditEnabled": true, - "ncSiteUrl": "http://localhost:8080", - "ee": false, - "ncAttachmentFieldSize": 20971520, - "ncMaxAttachmentsAllowed": 10 - } - }, - "properties": { - "authType": { - "type": "string" - }, - "projectHasAdmin": { - "type": "boolean" - }, - "firstUser": { - "type": "boolean" - }, - "type": { - "type": "string" - }, - "googleAuthEnabled": { - "type": "boolean" - }, - "githubAuthEnabled": { - "type": "boolean" - }, - "oneClick": { - "type": "boolean" - }, - "connectToExternalDB": { - "type": "boolean" - }, - "version": { - "type": "string" - }, - "defaultLimit": { - "type": "number" - }, - "ncMin": { - "type": "boolean" - }, - "teleEnabled": { - "type": "boolean" - }, - "auditEnabled": { - "type": "boolean" - }, - "ncSiteUrl": { - "type": "string" - }, - "ee": { - "type": "boolean" - }, - "ncAttachmentFieldSize": { - "type": "number" - }, - "ncMaxAttachmentsAllowed": { - "type": "number" - }, - "isCloud": { - "type": "boolean", - "x-stoplight": { - "id": "bstdkpky2131f" - } - }, - "automationLogLevel": { - "type": "string", - "x-stoplight": { - "id": "uc3vaotye2eu8" - }, - "enum": ["OFF", "ERROR", "ALL"], - "example": "OFF" - } - } - }, - "examples": { - "Example 1": { - "value": { - "authType": "jwt", - "projectHasAdmin": true, - "firstUser": false, - "type": "rest", - "googleAuthEnabled": false, - "githubAuthEnabled": false, - "oneClick": false, - "connectToExternalDB": true, - "version": "0.105.3", - "defaultLimit": 25, - "ncMin": false, - "teleEnabled": false, - "auditEnabled": true, - "ncSiteUrl": "http://localhost:8080", - "ee": false, - "ncAttachmentFieldSize": 20971520, - "ncMaxAttachmentsAllowed": 10, - "isCloud": false, - "automationLogLevel": "OFF" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Utils"], - "description": "Get the application info such as authType, defaultLimit, version and etc.", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/axiosRequestMake": { - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "post": { - "summary": "Axios Request", - "operationId": "utils-axios-request-make", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {} - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Generic Axios Call", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object" - } - } - } - }, - "tags": ["Utils"], - "x-internal": true, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/version": { - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "get": { - "summary": "Get App Version", - "operationId": "utils-app-version", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "x-examples": { - "Example 1": { - "currentVersion": "0.105.3", - "releaseVersion": "0.105.3" - } - }, - "properties": { - "currentVersion": { - "type": "string", - "description": "Current NocoDB Version", - "example": "0.104.0" - }, - "releaseVersion": { - "type": "string", - "description": "Latest Release Version", - "example": "0.105.3" - } - } - }, - "examples": { - "Example 1": { - "value": { - "currentVersion": "0.104.0", - "releaseVersion": "0.105.3" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Utils"], - "description": "Get the application version", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/health": { - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "get": { - "summary": "Get Application Health Status", - "operationId": "utils-app-health", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "x-examples": { - "Example 1": { - "message": "OK", - "timestamp": 1678702175755, - "uptime": 1618.996877834 - } - }, - "properties": { - "message": { - "type": "string", - "example": "OK" - }, - "timestamp": { - "type": "string", - "example": "1678702175755" - }, - "uptime": { - "type": "string", - "example": "1618.996877834" - } - } - }, - "examples": { - "Example 1": { - "value": { - "message": "OK", - "timestamp": 1678702175755, - "uptime": 1618.996877834 - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Utils"], - "description": "Get Application Health Status", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/aggregated-meta-info": { - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "get": { - "summary": "Get Aggregated Meta Info", - "operationId": "utils-aggregated-meta-info", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "projectCount": { - "type": "integer" - }, - "projects": { - "type": "array", - "items": { - "type": "object", - "properties": { - "tableCount": { - "type": "object", - "properties": { - "table": { - "type": "integer", - "description": "Table Count" - }, - "view": { - "type": "integer", - "description": "View Count" - } - } - }, - "external": { - "type": "boolean", - "description": "External Project", - "default": false - }, - "viewCount": { - "type": "object", - "properties": { - "formCount": { - "type": "integer", - "description": "Form Count" - }, - "gridCount": { - "type": "integer", - "description": "Grid Count" - }, - "galleryCount": { - "type": "integer", - "description": "Gallery Count" - }, - "kanbanCount": { - "type": "integer", - "description": "Kanban Count" - }, - "total": { - "type": "integer", - "description": "Total View Count" - }, - "sharedFormCount": { - "type": "integer", - "description": "Shared Form Count" - }, - "sharedGridCount": { - "type": "integer", - "description": "Shared Grid Count" - }, - "sharedGalleryCount": { - "type": "integer", - "description": "Shared Gallery Count" - }, - "sharedKanbanCount": { - "type": "integer", - "description": "Shared Kanban Count" - }, - "sharedTotal": { - "type": "integer", - "description": "Shared Total View Count" - }, - "sharedLockedCount": { - "type": "integer", - "description": "Shared Locked View Count" - } - } - }, - "webhookCount": { - "type": "integer", - "description": "Webhook Count" - }, - "filterCount": { - "type": "integer", - "description": "Filter Count" - }, - "sortCount": { - "type": "integer", - "description": "Sort Count" - }, - "rowCount": { - "type": "array", - "items": { - "type": "object", - "properties": { - "TotalRecords": { - "type": "string" - } - } - }, - "description": "Row Count" - }, - "userCount": { - "type": "integer", - "description": "Total project user Count" - } - } - } - }, - "userCount": { - "type": "integer", - "description": "Total user Count" - }, - "sharedBaseCount": { - "type": "integer", - "description": "Total shared base Count" - } - }, - "x-examples": { - "Example 1": { - "projectCount": 1, - "projects": [ - { - "tableCount": { - "table": 3, - "view": 0 - }, - "external": false, - "viewCount": { - "formCount": 0, - "gridCount": 3, - "galleryCount": 0, - "kanbanCount": 0, - "total": 3, - "sharedFormCount": 0, - "sharedGridCount": 0, - "sharedGalleryCount": 0, - "sharedKanbanCount": 0, - "sharedTotal": 0, - "sharedLockedCount": 0 - }, - "webhookCount": 0, - "filterCount": 0, - "sortCount": 0, - "rowCount": [ - { - "TotalRecords": "76" - } - ], - "userCount": 1 - } - ], - "userCount": 1, - "sharedBaseCount": 0 - } - } - }, - "examples": { - "example-1": { - "value": { - "projectCount": 1, - "projects": [ - { - "tableCount": { - "table": 3, - "view": 0 - }, - "external": false, - "viewCount": { - "formCount": 0, - "gridCount": 3, - "galleryCount": 0, - "kanbanCount": 0, - "total": 3, - "sharedFormCount": 0, - "sharedGridCount": 0, - "sharedGalleryCount": 0, - "sharedKanbanCount": 0, - "sharedTotal": 0, - "sharedLockedCount": 0 - }, - "webhookCount": 0, - "filterCount": 0, - "sortCount": 0, - "rowCount": [ - { - "TotalRecords": "76" - } - ], - "userCount": 1 - } - ], - "userCount": 1, - "sharedBaseCount": 0 - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Utils"], - "description": "Get Aggregated Meta Info such as tableCount, dbViewCount, viewCount and etc.", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - }, - "/api/v1/db/meta/cache": { - "get": { - "summary": "Get Cache", - "tags": ["Utils"], - "responses": {}, - "operationId": "utils-cache-get", - "description": "Get All K/V pairs in NocoCache", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "delete": { - "summary": "Delete Cache", - "operationId": "utils-cache-delete", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "boolean" - }, - "examples": { - "Example 1": { - "value": true - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "description": "Delete All K/V pairs in NocoCache", - "tags": ["Utils"], - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "/api/v1/db/meta/projects/{projectId}/api-tokens": { - "get": { - "summary": "List API Tokens in Project", - "tags": ["API Token"], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiTokenList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "id": "1", - "fk_user_id": "us_b3xo2i44nx5y9l", - "description": "This API Token is for ABC application", - "token": "DYh540o8hbWpUGdarekECKLdN5OhlgCUWutVJYX2" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "operationId": "api-token-list", - "description": "List API Tokens in the given project", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "post": { - "summary": "Create API Token", - "operationId": "api-token-create", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiToken" - }, - "examples": { - "Example 1": { - "value": { - "id": "1", - "fk_user_id": "us_b3xo2i44nx5y9l", - "description": "This API Token is for ABC application", - "token": "DYh540o8hbWpUGdarekECKLdN5OhlgCUWutVJYX2" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiTokenReq" - }, - "examples": { - "Example 1": { - "value": { - "description": "This API token is for ABC application" - } - } - } - } - }, - "description": "" - }, - "tags": ["API Token"], - "description": "Create API Token in a project", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - } - ] - }, - "/api/v1/db/meta/projects/{projectId}/api-tokens/{token}": { - "delete": { - "summary": "Delete API Token", - "operationId": "api-token-delete", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "number", - "example": 1 - }, - "examples": { - "Example 1": { - "value": 1 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["API Token"], - "description": "Delete the given API Token in project", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - }, - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - }, - { - "schema": { - "type": "string", - "example": "DYh540o8hbWpUGdarekECKLdN5OhlgCUWutVJYX2" - }, - "name": "token", - "in": "path", - "required": true, - "description": "API Token" - } - ] - }, - "/api/v1/db/storage/upload": { - "post": { - "summary": "Attachment Upload", - "operationId": "storage-upload", - "responses": {}, - "tags": ["Storage"], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "$ref": "#/components/schemas/AttachmentReq" - }, - "examples": { - "Example 1": { - "value": { - "mimetype": "image/jpeg", - "path": "download/noco/jango_fett/Table1/attachment/uVbjPVQxC_SSfs8Ctx.jpg", - "size": 13052, - "title": "22bc-kavypmq4869759 (1).jpg" - } - } - } - } - }, - "description": "" - }, - "parameters": [ - { - "schema": { - "type": "string", - "example": "download/noco/jango_fett/Table1/attachment/uVbjPVQxC_SSfs8Ctx.jpg" - }, - "name": "path", - "in": "query", - "required": true, - "description": "Target File Path" - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "description": "Upload attachment" - } - }, - "/api/v1/db/storage/upload-by-url": { - "post": { - "summary": "Attachment Upload by URL", - "operationId": "storage-upload-by-url", - "responses": {}, - "tags": ["Storage"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AttachmentReq" - } - }, - "examples": {} - } - } - }, - "parameters": [ - { - "schema": { - "type": "string", - "example": "download/noco/jango_fett/Table1/attachment/c7z_UF8sZBgJUxMjpN.jpg" - }, - "name": "path", - "in": "query", - "description": "Target File Path", - "required": true - }, - { - "$ref": "#/components/parameters/xc-auth" - } - ], - "description": "Upload attachment by URL. Used in Airtable Migration." - } - }, - "/api/v1/db/meta/projects/{projectId}/users/{userId}/resend-invite": { - "parameters": [ - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "name": "projectId", - "in": "path", - "required": true, - "description": "Unique Project ID" - }, - { - "schema": { - "$ref": "#/components/schemas/Id", - "example": "us_b3xo2i44nx5y9l" - }, - "name": "userId", - "in": "path", - "required": true, - "description": "Unique User ID" - } - ], - "post": { - "summary": "Resend User Invitation", - "operationId": "auth-project-user-resend-invite", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "m570oh5j3afjt" - }, - "description": "Success Message", - "example": "The invitation has been sent to the user" - } - } - }, - "examples": { - "Example 1": { - "value": { - "msg": "The invitation has been sent to the user" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - } - }, - "tags": ["Auth"], - "description": "Resend Invitation to a specific user", - "parameters": [ - { - "$ref": "#/components/parameters/xc-auth" - } - ] - } - } - }, - "components": { - "schemas": { - "ApiToken": { - "description": "Model for API Token", - "examples": [ - { - "id": "1", - "fk_user_id": "us_b3xo2i44nx5y9l", - "description": "This API Token is for ABC application", - "token": "DYh540o8hbWpUGdarekECKLdN5OhlgCUWutVJYX2" - } - ], - "title": "API Token Model", - "type": "object", - "properties": { - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique API Token ID" - }, - "fk_user_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to User" - }, - "description": { - "type": "string", - "description": "API Token Description", - "example": "This API Token is for ABC application" - }, - "token": { - "type": "string", - "description": "API Token", - "example": "DYh540o8hbWpUGdarekECKLdN5OhlgCUWutVJYX2" - } - }, - "x-stoplight": { - "id": "95rfb0httdmw0" - } - }, - "ApiTokenReq": { - "description": "Model for API Token Request", - "examples": [ - { - "description": "This API token is for ABC application" - } - ], - "title": "API Token Request Model", - "type": "object", - "properties": { - "description": { - "description": "Description of the API token", - "maxLength": 255, - "type": "string", - "example": "This API Token is for ABC application" - } - }, - "x-stoplight": { - "id": "h3g2houpa6y9y" - } - }, - "ApiTokenList": { - "description": "Model for API Token List", - "x-stoplight": { - "id": "35b7cvjplxmfm" - }, - "examples": [ - { - "list": [ - { - "id": "1", - "fk_user_id": "us_b3xo2i44nx5y9l", - "description": "This API Token is for ABC application", - "token": "DYh540o8hbWpUGdarekECKLdN5OhlgCUWutVJYX2" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - ], - "title": "API Token List Model", - "type": "object", - "properties": { - "list": { - "type": "array", - "example": [ - { - "list": [ - { - "id": "1", - "fk_user_id": "us_b3xo2i44nx5y9l", - "description": "This API Token is for ABC application", - "token": "DYh540o8hbWpUGdarekECKLdN5OhlgCUWutVJYX2" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - ], - "x-stoplight": { - "id": "c7xu43yjgyjww" - }, - "description": "List of api token objects", - "items": { - "$ref": "#/components/schemas/ApiToken", - "x-stoplight": { - "id": "5ih4l0ix2tr5q" - } - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated", - "x-stoplight": { - "id": "0w8ktfnx3pusz" - }, - "description": "Model for Paginated" - } - }, - "required": ["list", "pageInfo"] - }, - "Attachment": { - "description": "Model for Attachment", - "examples": [ - { - "data": null, - "mimetype": "image/jpeg", - "path": "download/noco/jango_fett/Table1/attachment/c7z_UF8sZBgJUxMjpN.jpg", - "size": 12345, - "title": "kavypmq4869759.jpg" - } - ], - "title": "Attachment Model", - "type": "object", - "properties": { - "data": { - "description": "Data for uploading" - }, - "mimetype": { - "type": "string", - "description": "The mimetype of the attachment" - }, - "path": { - "type": "string", - "description": "File Path" - }, - "size": { - "type": "number", - "description": "Attachment Size" - }, - "title": { - "type": "string", - "description": "The title of the attachment. Used in UI." - }, - "url": { - "type": "string", - "description": "Attachment URL" - } - }, - "x-stoplight": { - "id": "pbx8hqgwdz7lw" - } - }, - "AttachmentReq": { - "description": "Model for Attachment Request", - "type": "object", - "x-examples": { - "Example 1": { - "mimetype": "image/jpeg", - "path": "download/noco/jango_fett/Table1/attachment/uVbjPVQxC_SSfs8Ctx.jpg", - "size": 13052, - "title": "22bc-kavypmq4869759 (1).jpg" - } - }, - "title": "Attachment Request Model", - "properties": { - "mimetype": { - "type": "string", - "description": "The mimetype of the attachment" - }, - "path": { - "type": "string", - "description": "The file path of the attachment" - }, - "size": { - "type": "number", - "description": "The size of the attachment" - }, - "title": { - "type": "string", - "description": "The title of the attachment used in UI" - }, - "url": { - "type": "string", - "description": "Attachment URL to be uploaded via upload-by-url" - } - }, - "x-stoplight": { - "id": "jmahtr8c5rw7f" - } - }, - "Audit": { - "description": "Model for Audit", - "examples": [ - { - "id": "adt_l5we7pkx70vaao", - "user": "w@nocodb.com", - "ip": "::ffff:127.0.0.1", - "base_id": "ds_3l9qx8xqksenrl", - "project_id": "p_9sx43moxhqtjm3", - "fk_model_id": "md_ehn5izr99m7d45", - "row_id": "rec0Adp9PMG9o7uJy", - "op_type": "AUTHENTICATION", - "op_sub_type": "UPDATE", - "status": "string", - "description": "Table nc_snms___Table_1 : field Date got changed from 2023-03-12 to ", - "details": "Date : 2023-03-12 " - } - ], - "title": "Audit Model", - "type": "object", - "properties": { - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "user": { - "type": "string", - "description": "The user name performing the action", - "example": "w@nocodb.com" - }, - "ip": { - "type": "string", - "example": "::ffff:127.0.0.1", - "description": "IP address from the user" - }, - "base_id": { - "type": "string", - "description": "Base ID in where action is performed", - "example": "ds_3l9qx8xqksenrl" - }, - "project_id": { - "type": "string", - "description": "Project ID in where action is performed", - "example": "p_9sx43moxhqtjm3" - }, - "fk_model_id": { - "type": "string", - "description": "Model ID in where action is performed", - "example": "md_ehn5izr99m7d45" - }, - "row_id": { - "type": "string", - "description": "Row ID", - "example": "rec0Adp9PMG9o7uJy" - }, - "op_type": { - "type": "string", - "description": "Operation Type", - "example": "AUTHENTICATION", - "enum": [ - "COMMENT", - "DATA", - "PROJECT", - "VIRTUAL_RELATION", - "RELATION", - "TABLE_VIEW", - "TABLE", - "VIEW", - "META", - "WEBHOOKS", - "AUTHENTICATION", - "TABLE_COLUMN", - "ORG_USER" - ] - }, - "op_sub_type": { - "type": "string", - "description": "Operation Sub Type", - "example": "UPDATE", - "enum": [ - "UPDATE", - "INSERT", - "BULK_INSERT", - "BULK_UPDATE", - "BULK_DELETE", - "LINK_RECORD", - "UNLINK_RECORD", - "DELETE", - "CREATE", - "RENAME", - "IMPORT_FROM_ZIP", - "EXPORT_TO_FS", - "EXPORT_TO_ZIP", - "SIGNIN", - "SIGNUP", - "PASSWORD_RESET", - "PASSWORD_FORGOT", - "PASSWORD_CHANGE", - "EMAIL_VERIFICATION", - "ROLES_MANAGEMENT", - "INVITE", - "RESEND_INVITE" - ] - }, - "status": { - "type": "string", - "description": "Audit Status" - }, - "description": { - "type": "string", - "description": "Description of the action", - "example": "Table nc_snms___Table_1 : field Date got changed from 2023-03-12 to " - }, - "details": { - "type": "string", - "description": "Detail", - "example": "Date : 2023-03-12 " - } - }, - "x-stoplight": { - "id": "i5ug0n7j1wub8" - } - }, - "AuditRowUpdateReq": { - "description": "Model for Audit Row Update Request", - "examples": [ - { - "column_name": "baz", - "fk_model_id": "md_ehn5izr99m7d45", - "row_id": "rec0Adp9PMG9o7uJy", - "prev_value": "foo", - "value": "bar" - } - ], - "title": "Audit Row Update Request Model", - "type": "object", - "properties": { - "column_name": { - "type": "string", - "description": "Column Name", - "example": "baz" - }, - "fk_model_id": { - "type": "string", - "description": "Foreign Key to Model", - "example": "md_ehn5izr99m7d45" - }, - "row_id": { - "type": "string", - "example": "rec0Adp9PMG9o7uJy", - "description": "Row ID" - }, - "prev_value": { - "description": "The previous value before the action" - }, - "value": { - "description": "The current value after the action" - } - }, - "x-stoplight": { - "id": "jcw57b1yv3xog" - } - }, - "Base": { - "description": "Model for Base", - "examples": [ - { - "alias": null, - "config": "", - "enabled": 1, - "id": "ds_krsappzu9f8vmo", - "inflection_column": "camelize", - "inflection_table": "camelize", - "is_meta": 1, - "meta": null, - "order": 1, - "project_id": "p_01clqvzik3izk6", - "type": "mysql2" - } - ], - "title": "Base Model", - "type": "object", - "properties": { - "alias": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Base Name - Default BASE will be null by default" - }, - "config": { - "description": "Base Configuration" - }, - "enabled": { - "$ref": "#/components/schemas/Bool", - "description": "Is this base enabled" - }, - "id": { - "description": "Unique Base ID", - "type": "string" - }, - "inflection_column": { - "description": "Inflection for columns", - "example": "camelize", - "type": "string" - }, - "inflection_table": { - "description": "Inflection for tables", - "example": "camelize", - "type": "string" - }, - "is_meta": { - "$ref": "#/components/schemas/Bool", - "description": "Is the data source connected externally" - }, - "order": { - "description": "The order of the list of bases", - "example": 1, - "type": "number" - }, - "project_id": { - "description": "The project ID that this base belongs to", - "type": "string" - }, - "type": { - "description": "DB Type", - "enum": [ - "mssql", - "mysql", - "mysql2", - "oracledb", - "pg", - "snowflake", - "sqlite3" - ], - "example": "mysql2", - "type": "string" - } - }, - "x-stoplight": { - "id": "9hy3cgp0r2c95" - } - }, - "BaseList": { - "description": "Model for Base List", - "examples": [ - { - "list": [ - { - "alias": null, - "config": "", - "enabled": 1, - "id": "ds_krsappzu9f8vmo", - "inflection_column": "camelize", - "inflection_table": "camelize", - "is_meta": 1, - "meta": null, - "order": 1, - "project_id": "p_01clqvzik3izk6", - "type": "mysql2" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - ], - "title": "Base List Model", - "type": "object", - "x-examples": { - "example-1": { - "bases": { - "list": [ - { - "alias": "sakila", - "config": "", - "created_at": "2023-03-02 11:28:17", - "enabled": 1, - "id": "ds_btbdt19zde0gj9", - "inflection_column": "camelize", - "inflection_table": "camelize", - "is_meta": null, - "meta": null, - "order": 2, - "project_id": "p_01clqvzik3izk6", - "type": "mysql2", - "updated_at": "2023-03-02 11:28:17" - }, - { - "alias": null, - "config": "", - "created_at": "2023-03-01 16:31:49", - "enabled": 1, - "id": "ds_krsappzu9f8vmo", - "inflection_column": "camelize", - "inflection_table": "camelize", - "is_meta": 1, - "meta": null, - "order": 1, - "project_id": "p_01clqvzik3izk6", - "type": "mysql2", - "updated_at": "2023-03-02 11:28:17" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 2, - "totalRows": 2 - } - } - } - }, - "properties": { - "list": { - "type": "array", - "x-stoplight": { - "id": "1q3ny60j1g4z2" - }, - "description": "List of base objects", - "items": { - "$ref": "#/components/schemas/Base", - "x-stoplight": { - "id": "udd0nrcv6pq8d" - } - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated", - "x-stoplight": { - "id": "xqwcniocq37hk" - }, - "description": "Paginated Info" - } - }, - "required": ["list", "pageInfo"], - "x-stoplight": { - "id": "kk8uqxeefumma" - } - }, - "BaseReq": { - "description": "Model for Base Request", - "examples": [ - { - "alias": "My Base", - "config": null, - "inflection_column": "camelize", - "inflection_table": "camelize", - "is_meta": true, - "type": "mysql" - } - ], - "properties": { - "alias": { - "description": "Base Name - Default BASE will be null by default", - "example": "My Base", - "maxLength": 128, - "type": "string" - }, - "config": { - "description": "Base Configuration" - }, - "inflection_column": { - "description": "Inflection for columns", - "example": "camelize", - "type": "string" - }, - "inflection_table": { - "description": "Inflection for tables", - "example": "camelize", - "type": "string" - }, - "is_meta": { - "description": "Is the data source connected externally", - "type": "boolean" - }, - "type": { - "description": "DB Type", - "enum": [ - "mssql", - "mysql", - "mysql2", - "oracledb", - "pg", - "snowflake", - "sqlite3" - ], - "type": "string" - } - }, - "title": "Base Request", - "type": "object", - "x-stoplight": { - "id": "j2z6ain3204zi" - } - }, - "Bool": { - "description": "Model for Bool", - "examples": [true], - "oneOf": [ - { - "description": "0 or 1", - "example": 0, - "type": "integer" - }, - { - "description": "true or false", - "type": "boolean" - }, - { - "type": "null" - } - ], - "title": "Bool Model", - "x-stoplight": { - "id": "8n3vnyr22sbvj" - } - }, - "Column": { - "description": "Model for Column", - "examples": [ - { - "ai": 0, - "au": 0, - "base_id": "ds_krsappzu9f8vmo", - "cc": "", - "cdf": null, - "clen": "45", - "column_name": "title", - "cop": "2", - "created_at": "2023-03-02 13:14:16", - "csn": "utf8mb4", - "ct": "varchar(45)", - "deleted": null, - "dt": "varchar", - "dtx": "specificType", - "dtxp": "45", - "dtxs": null, - "fk_model_id": "md_yvwvbt2i78rgcm", - "id": "cl_0j9gv0oi8vjy46", - "meta": null, - "np": null, - "ns": null, - "order": 2, - "pk": 0, - "project_id": "p_01clqvzik3izk6", - "pv": 1, - "rqd": 0, - "system": 0, - "title": "Title", - "uidt": "SingleLineText", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 13:14:16", - "validate": null, - "virtual": null - } - ], - "title": "Column Model", - "type": "object", - "properties": { - "ai": { - "$ref": "#/components/schemas/Bool", - "description": "Is Auto-Increment?" - }, - "au": { - "$ref": "#/components/schemas/Bool", - "description": "Auto Update Timestamp" - }, - "base_id": { - "description": "Base ID that this column belongs to", - "example": "ds_krsappzu9f8vmo", - "type": "string" - }, - "cc": { - "description": "Column Comment", - "type": "string" - }, - "cdf": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Column Default" - }, - "clen": { - "description": "Character Maximum Length", - "oneOf": [ - { - "type": "integer" - }, - { - "type": "null" - }, - { - "type": "string" - } - ] - }, - "colOptions": { - "anyOf": [ - { - "$ref": "#/components/schemas/Formula" - }, - { - "$ref": "#/components/schemas/LinkToAnotherRecord" - }, - { - "$ref": "#/components/schemas/Lookup" - }, - { - "$ref": "#/components/schemas/Rollup" - }, - { - "$ref": "#/components/schemas/SelectOptions" - }, - { - "type": "object" - } - ], - "description": "Column Options" - }, - "column_name": { - "description": "Column Name", - "example": "title", - "type": "string" - }, - "cop": { - "description": "Column Ordinal Position", - "type": "string" - }, - "csn": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Character Set Name" - }, - "ct": { - "description": "Column Type", - "example": "varchar(45)", - "type": "string" - }, - "deleted": { - "$ref": "#/components/schemas/Bool", - "description": "Is Deleted?" - }, - "dt": { - "description": "Data Type in DB", - "example": "varchar", - "type": "string" - }, - "dtx": { - "description": "Data Type X", - "example": "specificType", - "type": "string" - }, - "dtxp": { - "description": "Data Type X Precision", - "oneOf": [ - { - "type": "null" - }, - { - "type": "number" - }, - { - "type": "string" - } - ] - }, - "dtxs": { - "description": "Data Type X Scale", - "oneOf": [ - { - "type": "null" - }, - { - "type": "number" - }, - { - "type": "string" - } - ] - }, - "fk_model_id": { - "description": "Model ID that this column belongs to", - "example": "md_yvwvbt2i78rgcm", - "type": "string" - }, - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "description": "Meta Info" - }, - "np": { - "description": "Numeric Precision", - "oneOf": [ - { - "type": "integer" - }, - { - "type": "null" - }, - { - "type": "string" - } - ] - }, - "ns": { - "description": "Numeric Scale", - "oneOf": [ - { - "type": "integer" - }, - { - "type": "null" - }, - { - "type": "string" - } - ] - }, - "order": { - "description": "The order of the list of columns", - "type": "number" - }, - "pk": { - "$ref": "#/components/schemas/Bool", - "description": "Is Primary Key?" - }, - "pv": { - "$ref": "#/components/schemas/Bool", - "description": "Is Primary Value?" - }, - "rqd": { - "$ref": "#/components/schemas/Bool", - "description": "Is Required?" - }, - "system": { - "$ref": "#/components/schemas/Bool", - "description": "Is System Column?" - }, - "title": { - "description": "Column Title", - "example": "Title", - "type": "string" - }, - "uidt": { - "description": "The data type in UI", - "example": "SingleLineText", - "enum": [ - "Attachment", - "AutoNumber", - "Barcode", - "Button", - "Checkbox", - "Collaborator", - "Count", - "CreateTime", - "Currency", - "Date", - "DateTime", - "Decimal", - "Duration", - "Email", - "Formula", - "ForeignKey", - "GeoData", - "Geometry", - "ID", - "JSON", - "LastModifiedTime", - "LongText", - "LinkToAnotherRecord", - "Lookup", - "MultiSelect", - "Number", - "Percent", - "PhoneNumber", - "Rating", - "Rollup", - "SingleLineText", - "SingleSelect", - "SpecificDBType", - "Time", - "URL", - "Year", - "QrCode" - ], - "type": "string" - }, - "un": { - "$ref": "#/components/schemas/Bool", - "description": "Is Unsigned?" - }, - "unique": { - "$ref": "#/components/schemas/Bool", - "description": "Is unique?" - }, - "visible": { - "$ref": "#/components/schemas/Bool", - "description": "Is Visible?" - } - }, - "x-stoplight": { - "id": "3a4lsn477mx4e" - } - }, - "ColumnList": { - "description": "Model for Column List", - "examples": [ - { - "list": [ - { - "ai": 0, - "au": 0, - "base_id": "ds_krsappzu9f8vmo", - "cc": "", - "cdf": null, - "clen": "45", - "column_name": "title", - "cop": "2", - "created_at": "2023-03-02 13:14:16", - "csn": "utf8mb4", - "ct": "varchar(45)", - "deleted": null, - "dt": "varchar", - "dtx": "specificType", - "dtxp": "45", - "dtxs": null, - "fk_model_id": "md_yvwvbt2i78rgcm", - "id": "cl_0j9gv0oi8vjy46", - "meta": null, - "np": null, - "ns": null, - "order": 2, - "pk": 0, - "project_id": "p_01clqvzik3izk6", - "pv": 1, - "rqd": 0, - "system": 0, - "title": "Title", - "uidt": "SingleLineText", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 13:14:16", - "validate": null, - "virtual": null - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - ], - "title": "Column List Model", - "type": "object", - "x-examples": { - "example-1": { - "bases": { - "list": [ - { - "alias": "string", - "database": "string", - "host": "string", - "id": "string", - "params": "string", - "password": "string", - "port": 0, - "project_id": "string", - "ssl": "string", - "type": "string", - "url": "string", - "username": "string" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "pageSize": 0, - "sort": "string", - "totalRows": 0 - } - } - } - }, - "properties": { - "list": { - "type": "array", - "x-stoplight": { - "id": "c6lpw8px25356" - }, - "description": "List of column objects", - "items": { - "$ref": "#/components/schemas/Column", - "x-stoplight": { - "id": "zbm89i86dr73y" - } - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated", - "x-stoplight": { - "id": "ko0s0z13h4hsw" - } - } - }, - "required": ["list", "pageInfo"], - "x-stoplight": { - "id": "rldg44w1alasg" - } - }, - "ColumnReq": { - "allOf": [ - { - "anyOf": [ - { - "$ref": "#/components/schemas/FormulaColumnReq" - }, - { - "$ref": "#/components/schemas/LinkToAnotherColumnReq" - }, - { - "$ref": "#/components/schemas/LookupColumnReq" - }, - { - "$ref": "#/components/schemas/NormalColumnRequest" - }, - { - "$ref": "#/components/schemas/RollupColumnReq" - } - ] - }, - { - "properties": { - "column_name": { - "type": "string" - }, - "column_order": { - "description": "Column order in a specific view", - "properties": { - "order": { - "type": "number" - }, - "view_id": { - "type": "string" - } - }, - "type": "object" - }, - "title": { - "maxLength": 255, - "minLength": 1, - "type": "string" - } - }, - "required": ["title"] - } - ], - "description": "Model for Column Request", - "examples": [ - { - "ai": 0, - "au": 0, - "base_id": "ds_krsappzu9f8vmo", - "cc": "", - "cdf": null, - "clen": "45", - "column_name": "title", - "cop": "2", - "created_at": "2023-03-02 13:14:16", - "csn": "utf8mb4", - "ct": "varchar(45)", - "deleted": null, - "dt": "varchar", - "dtx": "specificType", - "dtxp": "45", - "dtxs": null, - "fk_model_id": "md_yvwvbt2i78rgcm", - "id": "cl_0j9gv0oi8vjy46", - "meta": null, - "np": null, - "ns": null, - "order": 2, - "pk": 0, - "project_id": "p_01clqvzik3izk6", - "pv": 1, - "rqd": 0, - "system": 0, - "title": "Title", - "uidt": "SingleLineText", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 13:14:16", - "validate": null, - "virtual": null - } - ], - "title": "Column Request Model", - "type": "object", - "x-stoplight": { - "id": "dvbn9dnme6jgi" - } - }, - "CommentReq": { - "description": "Model for Comment Request", - "examples": [ - { - "description": "This is the comment for the row", - "fk_model_id": "md_ehn5izr99m7d45", - "row_id": "3" - } - ], - "title": "Comment Request Model", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Description for the target row", - "example": "This is the comment for the row" - }, - "fk_model_id": { - "type": "string", - "description": "Foreign Key to Model", - "example": "md_ehn5izr99m7d45" - }, - "row_id": { - "type": "string", - "description": "Row ID", - "example": "3" - } - }, - "required": ["fk_model_id", "row_id"], - "x-stoplight": { - "id": "7nwlyinuliuvy" - } - }, - "CommentUpdateReq": { - "description": "Model for Comment Update Request", - "x-stoplight": { - "id": "r0f3ng2rahe38" - }, - "examples": [ - { - "description": "This is the comment for the row" - } - ], - "title": "Comment Update Request Model", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Description for the target row", - "example": "This is the comment for the row" - } - } - }, - "Filter": { - "description": "Model for Filter", - "examples": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "comparison_op": "eq", - "comparison_sub_op": null, - "created_at": "2023-03-02 18:18:05", - "fk_column_id": "cl_d7ah9n2qfupgys", - "fk_hook_id": null, - "fk_parent_id": null, - "fk_view_id": "vw_b739e29vqmrxnf", - "id": "fi_xn647tpmdq8fu8", - "is_group": null, - "logical_op": "and", - "order": 1, - "project_id": "p_xm3thidrblw4n7", - "updated_at": "2023-03-02 18:18:05", - "value": "foo" - } - ], - "properties": { - "base_id": { - "description": "Unqiue Base ID", - "readOnly": true, - "type": "string" - }, - "children": { - "description": "Children filters. Available when the filter is grouped.", - "items": { - "$ref": "#/components/schemas/Filter" - }, - "type": "array" - }, - "comparison_op": { - "description": "Comparison Operator", - "enum": [ - "allof", - "anyof", - "blank", - "btw", - "checked", - "empty", - "eq", - "ge", - "gt", - "gte", - "in", - "is", - "isWithin", - "isnot", - "le", - "like", - "lt", - "lte", - "nallof", - "nanyof", - "nbtw", - "neq", - "nlike", - "not", - "notblank", - "notchecked", - "notempty", - "notnull", - "null" - ], - "type": "string" - }, - "comparison_sub_op": { - "anyOf": [ - { - "enum": [ - "daysAgo", - "daysFromNow", - "exactDate", - "nextMonth", - "nextNumberOfDays", - "nextWeek", - "nextYear", - "oneMonthAgo", - "oneMonthFromNow", - "oneWeekAgo", - "oneWeekFromNow", - "pastMonth", - "pastNumberOfDays", - "pastWeek", - "pastYear", - "today", - "tomorrow", - "yesterday" - ], - "type": "string" - }, - { - "type": "null" - } - ], - "description": "Comparison Sub-Operator" - }, - "fk_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Column" - }, - "fk_hook_id": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Foreign Key to Hook" - }, - "fk_model_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Model" - }, - "fk_parent_id": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Foreign Key to parent group." - }, - "fk_view_id": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Foreign Key to View" - }, - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "is_group": { - "description": "Is this filter grouped?", - "oneOf": [ - { - "type": "boolean" - }, - { - "type": "integer" - }, - { - "type": "null" - } - ] - }, - "logical_op": { - "description": "Logical Operator", - "enum": ["and", "not", "or"], - "type": "string" - }, - "project_id": { - "description": "Unique Project ID", - "readOnly": true, - "type": "string" - }, - "value": { - "description": "The filter value. Can be NULL for some operators." - } - }, - "readOnly": true, - "title": "Filter Model", - "type": "object", - "x-stoplight": { - "id": "f8vsb8alix01i" - } - }, - "FilterList": { - "description": "Model for Filter List", - "examples": [ - { - "list": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "comparison_op": "eq", - "comparison_sub_op": null, - "created_at": "2023-03-02 18:18:05", - "fk_column_id": "cl_d7ah9n2qfupgys", - "fk_hook_id": null, - "fk_parent_id": null, - "fk_view_id": "vw_b739e29vqmrxnf", - "id": "fi_xn647tpmdq8fu8", - "is_group": null, - "logical_op": "and", - "order": 1, - "project_id": "p_xm3thidrblw4n7", - "updated_at": "2023-03-02 18:18:05", - "value": "foo" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - ], - "title": "Filter List Model", - "type": "object", - "x-examples": { - "example-1": { - "bases": { - "list": [ - { - "alias": "string", - "database": "string", - "host": "string", - "id": "string", - "params": "string", - "password": "string", - "port": 0, - "project_id": "string", - "ssl": "string", - "type": "string", - "url": "string", - "username": "string" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "pageSize": 0, - "sort": "string", - "totalRows": 0 - } - } - } - }, - "properties": { - "list": { - "type": "array", - "x-stoplight": { - "id": "22sgv37ve9kxo" - }, - "description": "List of filter objects", - "items": { - "$ref": "#/components/schemas/Filter", - "x-stoplight": { - "id": "ttw5rxhy83k8p" - } - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated", - "x-stoplight": { - "id": "7cyrb1770mrzz" - } - } - }, - "required": ["list", "pageInfo"], - "x-stoplight": { - "id": "mfxg43iomcoue" - } - }, - "FilterLogList": { - "description": "Model for Filter Log List", - "x-stoplight": { - "id": "0voe9zdizy5qd" - }, - "examples": [ - { - "list": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "comparison_op": "eq", - "comparison_sub_op": null, - "created_at": "2023-03-02 18:18:05", - "fk_column_id": "cl_d7ah9n2qfupgys", - "fk_hook_id": null, - "fk_parent_id": null, - "fk_view_id": "vw_b739e29vqmrxnf", - "id": "fi_xn647tpmdq8fu8", - "is_group": null, - "logical_op": "and", - "order": 1, - "project_id": "p_xm3thidrblw4n7", - "updated_at": "2023-03-02 18:18:05", - "value": "foo" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - ], - "title": "Filter Log List Model", - "type": "object", - "x-examples": { - "example-1": { - "bases": { - "list": [ - { - "alias": "string", - "database": "string", - "host": "string", - "id": "string", - "params": "string", - "password": "string", - "port": 0, - "project_id": "string", - "ssl": "string", - "type": "string", - "url": "string", - "username": "string" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "pageSize": 0, - "sort": "string", - "totalRows": 0 - } - } - } - }, - "properties": { - "list": { - "type": "array", - "x-stoplight": { - "id": "22sgv37ve9kxo" - }, - "description": "List of filter objects", - "items": { - "$ref": "#/components/schemas/Filter", - "x-stoplight": { - "id": "ttw5rxhy83k8p" - } - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated", - "x-stoplight": { - "id": "7cyrb1770mrzz" - } - } - }, - "required": ["list", "pageInfo"] - }, - "FilterReq": { - "description": "Model for Filter Request", - "examples": [ - { - "comparison_op": "eq", - "comparison_sub_op": null, - "fk_column_id": "cl_d7ah9n2qfupgys", - "is_group": false, - "logical_op": "and", - "value": "foo" - } - ], - "title": "Filter Request Model", - "type": "object", - "x-stoplight": { - "id": "pugjn1hobswqf" - }, - "properties": { - "comparison_op": { - "description": "Comparison Operator", - "enum": [ - "allof", - "anyof", - "blank", - "btw", - "checked", - "empty", - "eq", - "ge", - "gt", - "gte", - "in", - "is", - "isWithin", - "isnot", - "le", - "like", - "lt", - "lte", - "nallof", - "nanyof", - "nbtw", - "neq", - "nlike", - "not", - "notblank", - "notchecked", - "notempty", - "notnull", - "null" - ], - "type": "string" - }, - "comparison_sub_op": { - "anyOf": [ - { - "enum": [ - "daysAgo", - "daysFromNow", - "exactDate", - "nextMonth", - "nextNumberOfDays", - "nextWeek", - "nextYear", - "oneMonthAgo", - "oneMonthFromNow", - "oneWeekAgo", - "oneWeekFromNow", - "pastMonth", - "pastNumberOfDays", - "pastWeek", - "pastYear", - "today", - "tomorrow", - "yesterday" - ], - "type": "string" - }, - { - "type": "null" - } - ], - "description": "Comparison Sub-Operator" - }, - "fk_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Column" - }, - "fk_parent_id": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Belong to which filter ID" - }, - "is_group": { - "$ref": "#/components/schemas/Bool", - "description": "Is this filter grouped?" - }, - "logical_op": { - "description": "Logical Operator", - "enum": ["and", "not", "or"], - "type": "string" - }, - "value": { - "description": "The filter value. Can be NULL for some operators." - } - }, - "readOnly": true - }, - "Form": { - "description": "Model for Form", - "examples": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "banner_image_url": null, - "columns": [ - { - "id": "fvc_ugj9zo5bzocxtl", - "base_id": "ds_g4ccx6e77h1dmi", - "project_id": "p_xm3thidrblw4n7", - "fk_view_id": "vw_kdf5cr7qmhksek", - "fk_column_id": "cl_phvuuwjrzcdo0g", - "uuid": null, - "label": null, - "help": null, - "description": null, - "required": null, - "show": 0, - "order": 1, - "created_at": "2023-03-04 16:40:47", - "updated_at": "2023-03-04 16:40:47", - "meta": {} - } - ], - "email": "user@example.com", - "fk_model_id": "md_rsu68aqjsbyqtl", - "heading": "My Form", - "lock_type": "collaborative", - "logo_url": null, - "meta": null, - "redirect_after_secs": null, - "redirect_url": null, - "show_blank_form": 0, - "subheading": "My Form Subheading", - "submit_another_form": 0, - "success_msg": "Thank you for the submission.", - "title": "Form View 1" - } - ], - "title": "Form Model", - "type": "object", - "properties": { - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID", - "x-stoplight": { - "id": "z6wjvs00d3qfk" - } - }, - "banner_image_url": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Banner Image URL. Not in use currently." - }, - "columns": { - "type": "array", - "description": "Form Columns", - "items": { - "$ref": "#/components/schemas/FormColumn" - } - }, - "email": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Email to sned after form is submitted" - }, - "fk_model_id": { - "type": "string", - "description": "Foreign Key to Model", - "example": "md_rsu68aqjsbyqtl" - }, - "base_id": { - "type": "string", - "description": "Base ID", - "example": "md_rsu68aqjsbyqtl", - "x-stoplight": { - "id": "kfz7tve8nzj6f" - } - }, - "heading": { - "type": "string", - "description": "The heading of the form", - "example": "My Form" - }, - "lock_type": { - "enum": ["collaborative", "locked", "personal"], - "type": "string", - "description": "Lock Type of this view", - "example": "collaborative" - }, - "logo_url": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Logo URL. Not in use currently." - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "description": "Meta Info for this view" - }, - "redirect_after_secs": { - "$ref": "#/components/schemas/StringOrNull", - "description": "The numbers of seconds to redirect after form submission" - }, - "redirect_url": { - "$ref": "#/components/schemas/StringOrNull", - "description": "URL to redirect after submission" - }, - "show_blank_form": { - "$ref": "#/components/schemas/Bool", - "description": "Show `Blank Form` after 5 seconds" - }, - "subheading": { - "type": "string", - "description": "The subheading of the form", - "example": "My Form Subheading" - }, - "submit_another_form": { - "$ref": "#/components/schemas/Bool", - "description": "Show `Submit Another Form` button" - }, - "success_msg": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Custom message after the form is successfully submitted" - }, - "title": { - "type": "string", - "description": "Form View Title", - "example": "Form View 1" - } - }, - "x-stoplight": { - "id": "918aga51qb7w1" - } - }, - "FormUpdateReq": { - "description": "Model for Form Update Request", - "examples": [ - { - "banner_image_url": null, - "email": "user@example.com", - "heading": "My Form", - "logo_url": null, - "meta": null, - "redirect_after_secs": null, - "redirect_url": null, - "show_blank_form": 0, - "subheading": "My Form Subheading", - "submit_another_form": 0, - "success_msg": "Thank you for the submission." - } - ], - "title": "Form Update Request Model", - "type": "object", - "properties": { - "banner_image_url": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Banner Image URL. Not in use currently." - }, - "email": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Email to sned after form is submitted" - }, - "heading": { - "description": "The heading of the form", - "example": "My Form", - "maxLength": 255, - "type": "string" - }, - "logo_url": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Logo URL. Not in use currently." - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "description": "Meta Info for this view" - }, - "redirect_after_secs": { - "$ref": "#/components/schemas/StringOrNull", - "description": "The numbers of seconds to redirect after form submission" - }, - "redirect_url": { - "$ref": "#/components/schemas/StringOrNull", - "description": "URL to redirect after submission" - }, - "show_blank_form": { - "$ref": "#/components/schemas/Bool", - "description": "Show `Blank Form` after 5 seconds" - }, - "subheading": { - "$ref": "#/components/schemas/StringOrNull", - "description": "The subheading of the form" - }, - "submit_another_form": { - "$ref": "#/components/schemas/Bool", - "description": "Show `Submit Another Form` button" - }, - "success_msg": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Custom message after the form is successfully submitted" - } - }, - "x-stoplight": { - "id": "zn4juts75pksq" - } - }, - "FormColumn": { - "description": "Model for Form Column", - "examples": [ - { - "id": "fvc_1m9b0aub791d4m", - "description": null, - "fk_column_id": "cl_ah9zavkn25ihyd", - "fk_view_id": "vw_6fqln9vdytdv8q", - "help": "This is a help text", - "label": "Form Label", - "meta": null, - "order": 1, - "required": 0, - "show": 0, - "uuid": null - } - ], - "title": "Form Column Model", - "type": "object", - "x-examples": { - "example-1": { - "_cn": "first_name", - "alias": "first_name", - "created_at": "2022-02-15 12:39:04", - "description": "dsdsdsdsd", - "fk_column_id": "cl_yvyhsl9u81tokc", - "fk_view_id": "vw_s1pf4umdnikoyn", - "help": null, - "id": "fvc_8z1i7t8aswkqxx", - "label": "dsdsds", - "order": 1, - "required": false, - "show": 1, - "enable_scanner": true, - "updated_at": "2022-02-15 12:39:16", - "uuid": null - } - }, - "properties": { - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "description": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Form Column Description (Not in use)" - }, - "fk_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Column" - }, - "fk_view_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to View" - }, - "help": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Form Column Help Text" - }, - "label": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Form Column Label" - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "description": "Meta Info" - }, - "order": { - "type": "number", - "description": "The order among all the columns in the form", - "example": 1 - }, - "required": { - "$ref": "#/components/schemas/Bool", - "description": "Is this form column required in submission?" - }, - "show": { - "$ref": "#/components/schemas/Bool", - "description": "Is this column shown in Form?" - }, - "enable_scanner": { - "$ref": "#/components/schemas/Bool", - "description": "Indicates whether the 'Fill by scan' button is visible for this column or not.", - "example": true - }, - "uuid": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Form Column UUID (Not in use)" - } - }, - "x-stoplight": { - "id": "gm46pinkspvrz" - } - }, - "FormColumnReq": { - "description": "Model for Form Column Request", - "examples": [ - { - "description": null, - "help": "This is a help text", - "label": "Form Label", - "meta": null, - "order": 1, - "required": 0, - "show": 0 - } - ], - "title": "Form Column Request Model", - "type": "object", - "x-examples": { - "example-1": { - "_cn": "first_name", - "alias": "first_name", - "created_at": "2022-02-15 12:39:04", - "description": "dsdsdsdsd", - "fk_column_id": "cl_yvyhsl9u81tokc", - "fk_view_id": "vw_s1pf4umdnikoyn", - "help": null, - "id": "fvc_8z1i7t8aswkqxx", - "label": "dsdsds", - "order": 1, - "required": false, - "show": 1, - "updated_at": "2022-02-15 12:39:16", - "uuid": null - } - }, - "properties": { - "description": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Form Column Description (Not in use)" - }, - "help": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Form Column Help Text" - }, - "label": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Form Column Label" - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "description": "Meta Info" - }, - "order": { - "type": "number", - "description": "The order among all the columns in the form" - }, - "required": { - "$ref": "#/components/schemas/Bool", - "description": "Is this form column required in submission?" - }, - "show": { - "$ref": "#/components/schemas/Bool", - "description": "Is this column shown in Form?" - } - }, - "x-stoplight": { - "id": "nmffmb1p3wkg9" - } - }, - "Formula": { - "description": "Model for Formula", - "examples": [ - { - "id": "fm_1lo8wqtvvipdns", - "fk_column_id": "cl_h2micb4jdnmsh1", - "formula": "CONCAT(\"FOO\", {{cl_c5knoi4xs4sfpt}})", - "formula_raw": "CONCAT(\"FOO\", {Title})", - "error": "Error Message shows here" - } - ], - "title": "Formula Model", - "type": "object", - "properties": { - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "fk_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Column" - }, - "formula": { - "type": "string", - "description": "Formula with column ID replaced", - "example": "CONCAT(\"FOO\", {{cl_c5knoi4xs4sfpt}})" - }, - "formula_raw": { - "type": "string", - "description": "Original Formula inputted in UI", - "example": "CONCAT(\"FOO\", {Title})" - }, - "error": { - "type": "string", - "description": "Error Message" - } - }, - "x-stoplight": { - "id": "hlu7yokpavxwb" - } - }, - "FormulaColumnReq": { - "description": "Model for Formula Column Request", - "examples": [ - { - "formula": "CONCAT(\"FOO\", {{cl_c5knoi4xs4sfpt}})", - "formula_raw": "CONCAT(\"FOO\", {Title})", - "title": "Formula", - "uidt": "Formula" - } - ], - "title": "Formula Column Request Model", - "type": "object", - "properties": { - "formula": { - "type": "string", - "description": "Formula with column ID replaced" - }, - "formula_raw": { - "type": "string", - "description": "Original Formula inputted in UI" - }, - "title": { - "maxLength": 255, - "minLength": 1, - "type": "string", - "description": "Formula Title" - }, - "uidt": { - "enum": ["Formula"], - "type": "string", - "description": "UI Data Type" - } - }, - "x-stoplight": { - "id": "v26r0c9hlimtv" - } - }, - "Gallery": { - "description": "Model for Gallery", - "examples": [ - { - "alias": "string", - "columns": [ - { - "fk_col_id": "string", - "fk_gallery_id": "string", - "help": "string", - "id": "string", - "label": "string" - } - ], - "cover_image": "string", - "cover_image_idx": 0, - "deleted": true, - "fk_cover_image_col_id": "string", - "fk_model_id": "string", - "fk_view_id": "string", - "lock_type": "collaborative", - "next_enabled": true, - "order": 0, - "prev_enabled": true, - "restrict_number": "string", - "restrict_size": "string", - "restrict_types": "string", - "title": "string" - } - ], - "properties": { - "alias": { - "type": "string" - }, - "columns": { - "items": { - "$ref": "#/components/schemas/GalleryColumn" - }, - "type": "array" - }, - "cover_image": { - "type": "string" - }, - "cover_image_idx": { - "type": "integer" - }, - "deleted": { - "$ref": "#/components/schemas/Bool" - }, - "fk_cover_image_col_id": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Foreign Key to Cover Image Column" - }, - "fk_model_id": { - "type": "string", - "description": "Foreign Key to Model" - }, - "fk_view_id": { - "type": "string", - "description": "Foreign Key to View" - }, - "lock_type": { - "enum": ["collaborative", "locked", "personal"], - "type": "string" - }, - "next_enabled": { - "$ref": "#/components/schemas/Bool" - }, - "order": { - "type": "number", - "description": "Order of Gallery" - }, - "prev_enabled": { - "$ref": "#/components/schemas/Bool" - }, - "restrict_number": { - "type": "string" - }, - "restrict_size": { - "type": "string" - }, - "restrict_types": { - "type": "string" - }, - "title": { - "type": "string" - } - }, - "title": "Gallery Model", - "type": "object", - "x-stoplight": { - "id": "i0h7av37o4eks" - } - }, - "GalleryColumn": { - "description": "Model for Gallery Column", - "examples": [ - { - "fk_col_id": "string", - "fk_gallery_id": "string", - "help": "string", - "id": "string", - "label": "string" - } - ], - "properties": { - "fk_col_id": { - "type": "string" - }, - "fk_gallery_id": { - "type": "string" - }, - "help": { - "type": "string" - }, - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "label": { - "type": "string" - } - }, - "title": "Gallery Column Model", - "type": "object", - "x-stoplight": { - "id": "jdhvl7gb33fqo" - } - }, - "GalleryUpdateReq": { - "description": "Model for Gallery View Update Request", - "x-stoplight": { - "id": "x57k1fq4101e1" - }, - "examples": [ - { - "fk_cover_image_col_id": "cl_ib8l4j1kiu1efx", - "meta": null - } - ], - "title": "Gallery View Update Request Model", - "type": "object", - "properties": { - "fk_cover_image_col_id": { - "$ref": "#/components/schemas/StringOrNull", - "description": "The id of the column that contains the cover image" - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "x-stoplight": { - "id": "zhp6jkrr54wuf" - }, - "description": "Meta Info" - } - } - }, - "GeoLocation": { - "description": "Model for Geo Location", - "examples": [ - { - "latitude": 18.52139, - "longitude": 179.87295 - } - ], - "properties": { - "latitude": { - "description": "The latitude of the location", - "example": 18.52139, - "exclusiveMaximum": 90, - "exclusiveMinimum": -90, - "format": "double", - "type": "number" - }, - "longitude": { - "description": "The longitude of the location", - "example": 179.87295, - "exclusiveMaximum": 180, - "exclusiveMinimum": -180, - "format": "double", - "type": "number" - } - }, - "title": "Geo Location Model", - "type": "object", - "x-stoplight": { - "id": "685e1l91iuxhv" - } - }, - "Grid": { - "description": "Model for Grid", - "examples": [ - { - "project_id": "p_xm3thidrblw4n7", - "base_id": "ds_g4ccx6e77h1dmi", - "fk_view_id": "vw_p2jcatxz4mvcfw", - "row_height": 1, - "meta": null, - "columns": [ - { - "id": "cl_phvuuwjrzcdo0g", - "base_id": "ds_g4ccx6e77h1dmi", - "project_id": "p_xm3thidrblw4n7", - "fk_model_id": "md_rsu68aqjsbyqtl", - "title": "Id", - "column_name": "id", - "uidt": "ID", - "dt": "int", - "np": "10", - "ns": "0", - "clen": null, - "cop": "1", - "pk": 1, - "pv": null, - "rqd": 1, - "un": 1, - "ct": "int unsigned", - "ai": 1, - "unique": 0, - "cdf": null, - "cc": "", - "csn": null, - "dtx": "specificType", - "dtxp": "", - "dtxs": "0", - "au": 0, - "validate": null, - "virtual": null, - "deleted": null, - "system": 0, - "order": 1, - "created_at": "2023-03-02 17:04:06", - "updated_at": "2023-03-02 17:04:06", - "meta": null - } - ] - } - ], - "title": "Grid Model", - "type": "object", - "properties": { - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID", - "x-stoplight": { - "id": "e3ti3fc0ocjyu" - } - }, - "project_id": { - "$ref": "#/components/schemas/Id", - "description": "Project ID", - "x-stoplight": { - "id": "e3ti3fc0ocjyu" - } - }, - "base_id": { - "$ref": "#/components/schemas/Id", - "description": "Base ID", - "x-stoplight": { - "id": "m8v3iyf1tidy9" - } - }, - "fk_view_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to View", - "x-stoplight": { - "id": "m8v3iyf1tidy9" - } - }, - "row_height": { - "type": "number", - "example": 1, - "description": "Row Height" - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "x-stoplight": { - "id": "n8cud3jyqw5yv" - }, - "description": "Meta info for Grid Model" - }, - "columns": { - "type": "array", - "x-stoplight": { - "id": "22y0gipx2jdf8" - }, - "description": "Grid View Columns", - "items": { - "$ref": "#/components/schemas/GridColumn", - "x-stoplight": { - "id": "nmzp6w3o6b24u" - } - } - } - }, - "x-stoplight": { - "id": "1xswddf91q5pu" - } - }, - "Grid - copy": { - "description": "Model for Grid", - "x-stoplight": { - "id": "xheueli0578g0" - }, - "examples": [ - { - "project_id": "p_xm3thidrblw4n7", - "base_id": "ds_g4ccx6e77h1dmi", - "fk_view_id": "vw_p2jcatxz4mvcfw", - "row_height": 1, - "meta": null, - "columns": [ - { - "id": "cl_phvuuwjrzcdo0g", - "base_id": "ds_g4ccx6e77h1dmi", - "project_id": "p_xm3thidrblw4n7", - "fk_model_id": "md_rsu68aqjsbyqtl", - "title": "Id", - "column_name": "id", - "uidt": "ID", - "dt": "int", - "np": "10", - "ns": "0", - "clen": null, - "cop": "1", - "pk": 1, - "pv": null, - "rqd": 1, - "un": 1, - "ct": "int unsigned", - "ai": 1, - "unique": 0, - "cdf": null, - "cc": "", - "csn": null, - "dtx": "specificType", - "dtxp": "", - "dtxs": "0", - "au": 0, - "validate": null, - "virtual": null, - "deleted": null, - "system": 0, - "order": 1, - "created_at": "2023-03-02 17:04:06", - "updated_at": "2023-03-02 17:04:06", - "meta": null - } - ] - } - ], - "title": "Grid Model", - "type": "object", - "properties": { - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID", - "x-stoplight": { - "id": "e3ti3fc0ocjyu" - } - }, - "project_id": { - "$ref": "#/components/schemas/Id", - "description": "Project ID", - "x-stoplight": { - "id": "e3ti3fc0ocjyu" - } - }, - "base_id": { - "$ref": "#/components/schemas/Id", - "description": "Base ID", - "x-stoplight": { - "id": "m8v3iyf1tidy9" - } - }, - "fk_view_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to View", - "x-stoplight": { - "id": "m8v3iyf1tidy9" - } - }, - "row_height": { - "type": "number", - "example": 1, - "description": "Row Height" - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "x-stoplight": { - "id": "n8cud3jyqw5yv" - }, - "description": "Meta info for Grid Model" - }, - "columns": { - "type": "array", - "x-stoplight": { - "id": "22y0gipx2jdf8" - }, - "description": "Grid View Columns", - "items": { - "$ref": "#/components/schemas/GridColumn", - "x-stoplight": { - "id": "nmzp6w3o6b24u" - } - } - } - } - }, - "GridColumn": { - "description": "Model for Grid Column", - "examples": [ - { - "id": "nc_c8jz4kxe6xvh11", - "fk_view_id": "vw_p2jcatxz4mvcfw", - "fk_column_id": "cl_c5knoi4xs4sfpt", - "project_id": "p_xm3thidrblw4n7", - "base_id": "ds_g4ccx6e77h1dmi", - "show": 0, - "order": 1, - "width": "200px", - "help": null - } - ], - "title": "Grid Column Model", - "type": "object", - "properties": { - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID", - "x-stoplight": { - "id": "jc14yojp52rqj" - } - }, - "fk_view_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to View", - "x-stoplight": { - "id": "vl18dbt5c2r8r" - } - }, - "fk_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Column", - "x-stoplight": { - "id": "2drg88fmodf3v" - } - }, - "project_id": { - "$ref": "#/components/schemas/Id", - "description": "Project ID", - "x-stoplight": { - "id": "2drg88fmodf3v" - } - }, - "base_id": { - "$ref": "#/components/schemas/Id", - "description": "Base ID", - "x-stoplight": { - "id": "2drg88fmodf3v" - } - }, - "show": { - "$ref": "#/components/schemas/Bool", - "x-stoplight": { - "id": "d47eer13oa8yr" - } - }, - "order": { - "type": "number", - "x-stoplight": { - "id": "d47eer13oa8yr" - }, - "example": 1, - "description": "Grid Column Order" - }, - "width": { - "type": "string", - "description": "Column Width", - "example": "200px" - }, - "help": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Column Help Text", - "x-stoplight": { - "id": "azwh6zn37qzkc" - } - } - }, - "x-stoplight": { - "id": "g06nri6t6h6ke" - } - }, - "GridColumnReq": { - "description": "Model for Grid Column Request", - "examples": [ - { - "fk_column_id": "cl_c5knoi4xs4sfpt", - "label": "My Column", - "width": "200px" - } - ], - "properties": { - "fk_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Column" - }, - "help": { - "maxLength": 255, - "type": "string" - }, - "label": { - "description": "The label of the column", - "example": "My Column", - "maxLength": 255, - "type": "string" - }, - "width": { - "description": "The width of the column", - "example": "200px", - "maxLength": 255, - "pattern": "^[0-9]+(px|%)$", - "type": "string" - } - }, - "title": "Grid Column Request Model", - "type": "object", - "x-stoplight": { - "id": "8v9cxve0332zg" - } - }, - "GridUpdateReq": { - "description": "Model for Grid View Update", - "x-stoplight": { - "id": "g10t5gray4bk5" - }, - "examples": [ - { - "row_height": "1", - "meta": null - } - ], - "title": "Grid View Update Model", - "type": "object", - "properties": { - "row_height": { - "type": "number", - "x-stoplight": { - "id": "m5976ax1q13cr" - }, - "description": "Row Height", - "example": 1 - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "x-stoplight": { - "id": "dugbkhe9iupqu" - }, - "description": "Meta Info for grid view" - } - } - }, - "Hook": { - "description": "Model for Hook", - "examples": [ - { - "active": 0, - "async": 0, - "description": "This is my hook description", - "env": "all", - "event": "after", - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "string", - "notification": "{\"type\":\"URL\",\"payload\":{\"method\":\"POST\",\"body\":\"{{ json data }}\",\"headers\":[{}],\"parameters\":[{}],\"auth\":\"\",\"path\":\"http://example.com\"}}", - "null": null, - "operation": "insert", - "retries": 10, - "retry_interval": 60000, - "timeout": 60000, - "title": "My Webhook" - } - ], - "title": "Hook Model", - "type": "object", - "x-stoplight": { - "id": "32blg2oqo6g7p" - }, - "properties": { - "active": { - "$ref": "#/components/schemas/Bool", - "description": "Is the hook active?" - }, - "async": { - "$ref": "#/components/schemas/Bool", - "description": "Is the hook aysnc?" - }, - "description": { - "type": "string", - "description": "Hook Description", - "example": "This is my hook description" - }, - "env": { - "type": "string", - "example": "all", - "description": "Environment for the hook" - }, - "event": { - "enum": ["after", "before"], - "type": "string", - "description": "Event Type for the operation", - "example": "after" - }, - "fk_model_id": { - "type": "string", - "description": "Foreign Key to Model", - "example": "md_rsu68aqjsbyqtl" - }, - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "notification": { - "description": "Hook Notification including info such as type, payload, method, body, and etc", - "type": ["object", "string"] - }, - "operation": { - "enum": [ - "insert", - "update", - "delete", - "bulkInsert", - "bulkUpdate", - "bulkDelete" - ], - "type": "string", - "description": "Hook Operation", - "example": "insert" - }, - "retries": { - "type": "number", - "description": "Retry Count", - "example": 10 - }, - "retry_interval": { - "type": "number", - "description": "Retry Interval", - "example": 60000 - }, - "timeout": { - "type": "number", - "example": 60000, - "description": "Timeout" - }, - "title": { - "type": "string", - "description": "Hook Title", - "example": "My Webhook" - }, - "type": { - "type": "string", - "description": "Hook Type" - }, - "version": { - "type": "string", - "x-stoplight": { - "id": "socewqvadj91n" - }, - "example": "v2", - "description": "Hook Version", - "enum": ["v1", "v2"] - } - } - }, - "HookReq": { - "description": "Model for Hook", - "x-stoplight": { - "id": "85vr8fx3oea31" - }, - "examples": [ - { - "active": 0, - "async": 0, - "description": "This is my hook description", - "env": "all", - "event": "after", - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "string", - "notification": "{\"type\":\"URL\",\"payload\":{\"method\":\"POST\",\"body\":\"{{ json data }}\",\"headers\":[{}],\"parameters\":[{}],\"auth\":\"\",\"path\":\"http://example.com\"}}", - "null": null, - "operation": "insert", - "retries": 10, - "retry_interval": 60000, - "timeout": 60000, - "title": "My Webhook", - "condition": false - } - ], - "title": "Hook Request Model", - "type": "object", - "properties": { - "active": { - "$ref": "#/components/schemas/Bool", - "description": "Is the hook active?" - }, - "async": { - "$ref": "#/components/schemas/Bool", - "description": "Is the hook aysnc?" - }, - "description": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Hook Description" - }, - "env": { - "type": "string", - "example": "all", - "description": "Environment for the hook" - }, - "event": { - "enum": ["after", "before"], - "type": "string", - "description": "Event Type for the operation", - "example": "after" - }, - "fk_model_id": { - "type": "string", - "description": "Foreign Key to Model", - "example": "md_rsu68aqjsbyqtl" - }, - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "notification": { - "description": "Hook Notification including info such as type, payload, method, body, and etc", - "type": ["object", "string"] - }, - "operation": { - "enum": [ - "insert", - "update", - "delete", - "bulkInsert", - "bulkUpdate", - "bulkDelete" - ], - "type": "string", - "description": "Hook Operation", - "example": "insert" - }, - "retries": { - "type": "number", - "description": "Retry Count", - "example": 10 - }, - "retry_interval": { - "type": "number", - "description": "Retry Interval", - "example": 60000 - }, - "timeout": { - "type": "number", - "example": 60000, - "description": "Timeout" - }, - "title": { - "type": "string", - "description": "Hook Title", - "example": "My Webhook" - }, - "type": { - "type": ["string", "null"], - "description": "Hook Type" - }, - "condition": { - "$ref": "#/components/schemas/Bool", - "x-stoplight": { - "id": "wwzoum7rrlwun" - }, - "description": "Is this hook assoicated with some filters" - } - }, - "required": ["event", "notification", "operation", "title"] - }, - "HookList": { - "description": "Model for Hook List", - "examples": [ - { - "list": [ - { - "active": 0, - "async": 0, - "description": "This is my hook description", - "env": "all", - "event": "after", - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "string", - "notification": "{\"type\":\"URL\",\"payload\":{\"method\":\"POST\",\"body\":\"{{ json data }}\",\"headers\":[{}],\"parameters\":[{}],\"auth\":\"\",\"path\":\"http://example.com\"}}", - "null": null, - "operation": "insert", - "retries": 10, - "retry_interval": 60000, - "timeout": 60000, - "title": "My Webhook" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - ], - "title": "Hook List Model", - "type": "object", - "x-examples": { - "example-1": { - "bases": { - "list": [ - { - "alias": "string", - "database": "string", - "host": "string", - "id": "string", - "params": "string", - "password": "string", - "port": 0, - "project_id": "string", - "ssl": "string", - "type": "string", - "url": "string", - "username": "string" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "pageSize": 0, - "sort": "string", - "totalRows": 0 - } - } - } - }, - "properties": { - "list": { - "minItems": 1, - "type": "array", - "uniqueItems": true, - "description": "List of hook objects", - "items": { - "$ref": "#/components/schemas/Hook" - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated" - } - }, - "required": ["list", "pageInfo"], - "x-stoplight": { - "id": "n2sbatqu55day" - } - }, - "HookLog": { - "description": "Model for Hook Log", - "examples": [ - { - "base_id": "ds_jxuewivwbxeum2", - "event": "after", - "execution_time": "98", - "fk_hook_id": "hk_035ijv5qdi97y5", - "id": "string", - "notifications": "{\"type\":\"URL\",\"payload\":{\"method\":\"POST\",\"body\":\"{{ json data }}\",\"headers\":[{}],\"parameters\":[{}],\"auth\":\"\",\"path\":\"https://webhook.site/6eb45ce5-b611-4be1-8b96-c2965755662b\"}}", - "operation": "insert", - "payload": "{\"method\":\"POST\",\"body\":\"{{ json data }}\",\"headers\":[{}],\"parameters\":[{}],\"auth\":\"\",\"path\":\"https://webhook.site/6eb45ce5-b611-4be1-8b96-c2965755662b\"}", - "project_id": "p_tbhl1hnycvhe5l", - "response": "{\"status\":200,\"statusText\":\"OK\",\"headers\":{\"server\":\"nginx\",\"content-type\":\"text/plain; charset=UTF-8\",\"transfer-encoding\":\"chunked\",\"connection\":\"close\",\"vary\":\"Accept-Encoding\",\"x-request-id\":\"53844a7d-ede8-4798-adf7-8af441908a72\",\"x-token-id\":\"6eb45ce5-b611-4be1-8b96-c2965755662b\",\"cache-control\":\"no-cache, private\",\"date\":\"Fri, 24 Mar 2023 10:50:10 GMT\"},\"config\":{\"url\":\"https://webhook.site/6eb45ce5-b611-4be1-8b96-c2965755662b\",\"method\":\"post\",\"data\":\"{\\\"type\\\":\\\"records.after.insert\\\",\\\"id\\\":\\\"a77d97dc-a3e4-4719-9b46-45f93e0cc99a\\\",\\\"data\\\":{\\\"table_id\\\":\\\"md_d8v403o74mf5lf\\\",\\\"table_name\\\":\\\"Sheet-2\\\"}}\",\"headers\":{\"Accept\":\"application/json, text/plain, */*\",\"Content-Type\":\"application/x-www-form-urlencoded\",\"User-Agent\":\"axios/0.21.4\",\"Content-Length\":138},\"params\":{}}}", - "test_call": 0, - "triggered_by": "w@nocodb.com", - "type": "URL" - } - ], - "title": "Hook Log Model", - "type": "object", - "x-stoplight": { - "id": "ni303795b18y5" - }, - "properties": { - "base_id": { - "type": "string", - "description": "Unique Base ID", - "example": "ds_jxuewivwbxeum2" - }, - "conditions": { - "type": "string", - "description": "Hook Conditions" - }, - "error": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Error" - }, - "error_code": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Error Code" - }, - "error_message": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Error Message" - }, - "event": { - "type": "string", - "description": "Hook Event", - "example": "after", - "enum": ["after", "before"] - }, - "execution_time": { - "type": "string", - "description": "Execution Time in milliseconds", - "example": "98" - }, - "fk_hook_id": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Foreign Key to Hook" - }, - "id": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Unique ID" - }, - "notifications": { - "type": "string", - "description": "Hook Notification" - }, - "operation": { - "type": "string", - "description": "Hook Operation", - "enum": [ - "insert", - "update", - "delete", - "bulkInsert", - "bulkUpdate", - "bulkDelete" - ], - "example": "insert" - }, - "payload": { - "type": "string", - "description": "Hook Payload", - "example": "{\"method\":\"POST\",\"body\":\"{{ json data }}\",\"headers\":[{}],\"parameters\":[{}],\"auth\":\"\",\"path\":\"https://webhook.site/6eb45ce5-b611-4be1-8b96-c2965755662b\"}" - }, - "project_id": { - "type": "string", - "description": "Project ID", - "example": "p_tbhl1hnycvhe5l" - }, - "response": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Hook Response" - }, - "test_call": { - "$ref": "#/components/schemas/Bool", - "description": "Is this testing hook call?" - }, - "triggered_by": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Who triggered the hook?" - }, - "type": { - "type": "string", - "example": "URL", - "description": "Hook Type" - } - } - }, - "HookLogList": { - "description": "Model for Hook Log List", - "x-stoplight": { - "id": "tfv7y629w2ap2" - }, - "examples": [], - "title": "Hook Log List Model", - "type": "object", - "x-examples": { - "example-1": { - "bases": { - "list": [ - { - "alias": "string", - "database": "string", - "host": "string", - "id": "string", - "params": "string", - "password": "string", - "port": 0, - "project_id": "string", - "ssl": "string", - "type": "string", - "url": "string", - "username": "string" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "pageSize": 0, - "sort": "string", - "totalRows": 0 - } - } - } - }, - "properties": { - "list": { - "minItems": 1, - "type": "array", - "uniqueItems": true, - "description": "List of hook objects", - "items": { - "$ref": "#/components/schemas/HookLog" - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated" - } - }, - "required": ["list", "pageInfo"] - }, - "HookTestReq": { - "description": "Model for Hook Test Request", - "examples": [ - { - "hook": { - "active": 0, - "async": 0, - "description": "This is my hook description", - "env": "all", - "event": "after", - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "string", - "notification": "{\"type\":\"URL\",\"payload\":{\"method\":\"POST\",\"body\":\"{{ json data }}\",\"headers\":[{}],\"parameters\":[{}],\"auth\":\"\",\"path\":\"http://example.com\"}}", - "null": null, - "operation": "insert", - "retries": 10, - "retry_interval": 60000, - "timeout": 60000, - "title": "My Webhook" - }, - "payload": { - "data": { - "Id": 1, - "Title": "Sample Text", - "CreatedAt": "2023-03-03T10:03:06.484Z", - "UpdatedAt": "2023-03-03T10:03:06.484Z", - "attachment": [ - { - "url": "https://nocodb.com/dummy.png", - "title": "image.png", - "mimetype": "image/png", - "size": 0 - } - ], - "f": "Sample Output" - } - } - } - ], - "title": "Hook Test Request Model", - "type": "object", - "properties": { - "hook": { - "$ref": "#/components/schemas/HookReq" - }, - "payload": { - "description": "Payload to be sent" - } - }, - "required": ["hook", "payload"], - "x-stoplight": { - "id": "w64q11jiv01np" - } - }, - "Id": { - "description": "Model for ID", - "examples": ["string"], - "maxLength": 20, - "minLength": 0, - "title": "ID Model", - "type": "string", - "x-stoplight": { - "id": "obj8r7jhyfoqg" - } - }, - "Kanban": { - "description": "Model for Kanban", - "examples": [ - { - "id": "vw_wqs4zheuo5lgdy", - "fk_grp_col_id": "cl_3704cxcbqt7sj7", - "fk_view_id": "vw_wqs4zheuo5lgdy", - "fk_cover_image_col_id": null, - "columns": [ - { - "id": "kvc_2skkg5mi1eb37f", - "fk_column_id": "cl_hzos4ghyncqi4k", - "fk_view_id": "vw_wqs4zheuo5lgdy", - "base_id": "ds_hd4ojj0xpquaam", - "project_id": "p_kzfl5lb0t3tcok", - "title": "string", - "show": 0, - "order": "1" - } - ], - "meta": null, - "title": "My Kanban" - } - ], - "title": "Kanban Model", - "type": "object", - "properties": { - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "fk_grp_col_id": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Grouping Field Column ID" - }, - "fk_view_id": { - "$ref": "#/components/schemas/Id", - "x-stoplight": { - "id": "1kgw1w06b97nl" - }, - "description": "View ID" - }, - "fk_cover_image_col_id": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Cover Image Column ID" - }, - "columns": { - "type": "array", - "description": "Kanban Columns", - "items": { - "$ref": "#/components/schemas/KanbanColumn" - } - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "description": "Meta Info for Kanban" - }, - "title": { - "type": "string", - "description": "Kanban Title", - "example": "My Kanban" - } - }, - "x-stoplight": { - "id": "sfbbvgbcv7je6" - } - }, - "KanbanColumn": { - "description": "Model for Kanban Column", - "examples": [ - { - "id": "kvc_2skkg5mi1eb37f", - "fk_column_id": "cl_hzos4ghyncqi4k", - "fk_view_id": "vw_wqs4zheuo5lgdy", - "base_id": "ds_hd4ojj0xpquaam", - "project_id": "p_kzfl5lb0t3tcok", - "title": "string", - "show": 0, - "order": "1" - } - ], - "title": "Kanban Column Model", - "type": "object", - "properties": { - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "fk_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Column" - }, - "fk_view_id": { - "$ref": "#/components/schemas/Id", - "x-stoplight": { - "id": "t1fy4zy561ih8" - }, - "description": "Foreign Key to View" - }, - "base_id": { - "$ref": "#/components/schemas/Id", - "x-stoplight": { - "id": "uqq8xmyz97t1u" - }, - "description": "Baes ID\n" - }, - "project_id": { - "$ref": "#/components/schemas/Id", - "x-stoplight": { - "id": "uqq8xmyz97t1u" - }, - "description": "Project ID" - }, - "title": { - "x-stoplight": { - "id": "uqq8xmyz97t1u" - }, - "description": "Project ID", - "type": "string" - }, - "show": { - "$ref": "#/components/schemas/Bool", - "x-stoplight": { - "id": "uqq8xmyz97t1u" - }, - "description": "Is this column shown?" - }, - "order": { - "type": "number", - "x-stoplight": { - "id": "pbnchzgci5dwa" - }, - "example": 1, - "description": "Column Order" - } - }, - "x-stoplight": { - "id": "epfedw9ccxgxe" - } - }, - "KanbanUpdateReq": { - "description": "Model for Kanban Update Request", - "examples": [ - { - "fk_grp_col_id": "cl_g0a89q9xdry3lu", - "fk_cover_image_col_id": "cl_ib8l4j1kiu1efx", - "meta": { - "cl_g0a89q9xdry3lu": [ - { - "id": "uncategorized", - "title": null, - "order": 0, - "color": "#c2f5e8", - "collapsed": false - }, - { - "id": "sl_ihyva6jx6dg0fc", - "fk_column_id": "cl_g0a89q9xdry3lu", - "title": "a", - "color": "#cfdffe", - "order": 1, - "collapsed": false - }, - { - "id": "sl_gqdm5v6t8aetoa", - "fk_column_id": "cl_g0a89q9xdry3lu", - "title": "b", - "color": "#d0f1fd", - "order": 2, - "collapsed": false - }, - { - "id": "sl_eipnl0kn7a9d3c", - "fk_column_id": "cl_g0a89q9xdry3lu", - "title": "cc", - "color": "#c2f5e8", - "order": 3, - "collapsed": false - }, - { - "id": "sl_dei8p2jq0cnlv0", - "fk_column_id": "cl_g0a89q9xdry3lu", - "title": "d", - "color": "#ffdaf6", - "order": 4, - "collapsed": false - } - ] - } - } - ], - "title": "Kanban Update Request Model", - "type": "object", - "properties": { - "fk_grp_col_id": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Foreign Key to Grouping Field Column" - }, - "fk_cover_image_col_id": { - "$ref": "#/components/schemas/StringOrNull", - "x-stoplight": { - "id": "81wn4hzj76wod" - }, - "description": "Foreign Key to Cover Image Column" - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "x-stoplight": { - "id": "stsvdmkli1b0r" - }, - "description": "Meta Info" - } - }, - "x-stoplight": { - "id": "b1jlyk12kfuwx" - } - }, - "LicenseReq": { - "description": "Model for Kanban Request", - "examples": [ - { - "key": "1234567890" - } - ], - "properties": { - "key": { - "description": "The license key", - "example": "1234567890", - "maxLength": 255, - "minLength": 10, - "type": "string" - } - }, - "title": "License Key Request Model", - "type": "object", - "x-stoplight": { - "id": "trgk6qlmgdyfo" - } - }, - "LinkToAnotherColumnReq": { - "description": "Model for LinkToAnotherColumn Request", - "examples": [ - { - "childId": "string", - "parentId": "string", - "title": "string", - "type": "hm", - "uidt": "LinkToAnotherRecord", - "virtual": true - } - ], - "properties": { - "childId": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to chhild column" - }, - "parentId": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to parent column" - }, - "title": { - "maxLength": 255, - "minLength": 1, - "type": "string", - "description": "The title of the virtual column" - }, - "type": { - "enum": ["bt", "hm", "mm"], - "type": "string", - "description": "The type of the relationship" - }, - "uidt": { - "enum": ["LinkToAnotherRecord"], - "type": "string", - "description": "Abstract type of the relationship" - }, - "virtual": { - "$ref": "#/components/schemas/Bool", - "description": "Is this relationship virtual?" - } - }, - "required": ["childId", "parentId", "title", "type", "uidt"], - "title": "LinkToAnotherColumn Request Model", - "type": "object", - "x-stoplight": { - "id": "x59gz5reg12x3" - } - }, - "LinkToAnotherRecord": { - "description": "Model for LinkToAnotherRecord", - "examples": [ - { - "deleted": "string", - "dr": "string", - "fk_child_column_id": "string", - "fk_column_id": "string", - "fk_index_name": "string", - "fk_mm_child_column_id": "string", - "fk_mm_model_id": "string", - "fk_mm_parent_column_id": "string", - "fk_parent_column_id": "string", - "fk_related_model_id": "string", - "id": "string", - "order": "string", - "type": "string", - "ur": "string", - "virtual": true - } - ], - "properties": { - "deleted": { - "type": "string" - }, - "dr": { - "type": "string" - }, - "fk_child_column_id": { - "type": "string" - }, - "fk_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Column" - }, - "fk_index_name": { - "type": "string" - }, - "fk_mm_child_column_id": { - "type": "string" - }, - "fk_mm_model_id": { - "type": "string" - }, - "fk_mm_parent_column_id": { - "type": "string" - }, - "fk_parent_column_id": { - "type": "string" - }, - "fk_related_model_id": { - "type": "string" - }, - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "order": { - "type": "string" - }, - "type": { - "type": "string" - }, - "ur": { - "type": "string" - }, - "virtual": { - "$ref": "#/components/schemas/Bool" - } - }, - "title": "LinkToAnotherRecord Model", - "type": "object", - "x-stoplight": { - "id": "27q0vnr79hxla" - } - }, - "Lookup": { - "description": "Model for Lookup", - "examples": [ - { - "id": "lk_mngsu0e45njbxr", - "fk_column_id": "cl_vdiy9bz7h11kdm", - "fk_relation_column_id": "cl_5jestblzneb649", - "fk_lookup_column_id": "cl_4cm47dtjphgqkv", - "order": 1 - } - ], - "title": "Lookup Model", - "type": "object", - "properties": { - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "fk_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Column" - }, - "fk_lookup_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Lookup Column" - }, - "fk_relation_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Relation Column" - }, - "order": { - "type": "number", - "description": "The order among the list", - "example": 1 - } - }, - "x-stoplight": { - "id": "guyozhka8sx1t" - } - }, - "LookupColumnReq": { - "description": "Model for Lookup Column Request", - "examples": [ - { - "fk_relation_column_id": "cl_5jestblzneb649", - "fk_lookup_column_id": "cl_4cm47dtjphgqkv", - "title": "My Lookup", - "uidt": "Lookup" - } - ], - "title": "Lookup Column Request Model", - "type": "object", - "properties": { - "fk_lookup_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Lookup Column" - }, - "fk_relation_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Relation Column" - }, - "title": { - "maxLength": 255, - "type": "string", - "description": "Lookup Title", - "example": "My Lookup" - }, - "uidt": { - "enum": ["Lookup"], - "type": "string", - "description": "UI DataType" - } - }, - "x-stoplight": { - "id": "hmeckhq2ciwpf" - } - }, - "Map": { - "description": "Model for Map", - "examples": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "columns": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "fk_column_id": "cl_8iw2o4ejzvdyna", - "fk_view_id": "vw_qjt7klod1p9kyv", - "id": "nc_46xcacqn4rc9xf", - "order": 1, - "project_id": "p_xm3thidrblw4n7", - "show": 1 - } - ], - "fk_geo_data_col_id": "cl_8iw2o4ejzvdyna", - "fk_view_id": "vw_qjt7klod1p9kyv", - "meta": {}, - "order": 0, - "project_id": "p_xm3thidrblw4n7", - "show": true, - "title": "My Map" - } - ], - "properties": { - "base_id": { - "description": "The ID of the base that this view belongs to", - "example": "ds_g4ccx6e77h1dmi", - "type": "string" - }, - "columns": { - "description": "Columns in this view", - "items": { - "$ref": "#/components/schemas/MapColumn" - }, - "type": "array" - }, - "fk_geo_data_col_id": { - "description": "Foreign Key to GeoData Column", - "example": "cl_8iw2o4ejzvdyna", - "type": "string" - }, - "fk_view_id": { - "description": "Unique ID for Map", - "example": "vw_qjt7klod1p9kyv", - "type": "string" - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "description": "Meta data for this view" - }, - "order": { - "description": "The order of the map list", - "type": "number" - }, - "project_id": { - "description": "The ID of the project that this view belongs to", - "example": "p_xm3thidrblw4n7", - "type": "string" - }, - "show": { - "description": "To show this Map or not", - "type": "boolean" - }, - "title": { - "description": "Title of Map View", - "example": "My Map", - "type": "string" - } - }, - "title": "Map Model", - "type": "object", - "x-stoplight": { - "id": "hd60sf3k0bs3w" - } - }, - "MapUpdateReq": { - "description": "Model for Map", - "x-stoplight": { - "id": "3hceyh9ukp5ln" - }, - "examples": [ - { - "fk_geo_data_col_id": "cl_8iw2o4ejzvdyna", - "meta": null - } - ], - "title": "Map View Update Request Model", - "type": "object", - "properties": { - "fk_geo_data_col_id": { - "description": "Foreign Key to GeoData Column", - "example": "cl_8iw2o4ejzvdyna", - "type": "string" - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "description": "Meta data for this view" - } - } - }, - "MapColumn": { - "description": "Model for Map Column", - "examples": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "fk_column_id": "cl_8iw2o4ejzvdyna", - "fk_view_id": "vw_qjt7klod1p9kyv", - "id": "nc_46xcacqn4rc9xf", - "order": 1, - "project_id": "p_xm3thidrblw4n7", - "show": 1 - } - ], - "properties": { - "base_id": { - "description": "The ID of the base that this map column belongs to", - "example": "ds_g4ccx6e77h1dmi", - "type": "string" - }, - "fk_column_id": { - "description": "Foreign Key to Column", - "example": "cl_8iw2o4ejzvdyna", - "type": "string" - }, - "fk_view_id": { - "description": "Foreign Key to View", - "example": "vw_qjt7klod1p9kyv", - "type": "string" - }, - "id": { - "description": "Unique ID of Map Column", - "example": "nc_46xcacqn4rc9xf", - "type": "string" - }, - "order": { - "description": "the order in the list of map columns", - "example": 1, - "type": "number" - }, - "project_id": { - "description": "The ID of the project that this map column belongs to", - "example": "p_xm3thidrblw4n7", - "type": "string" - }, - "show": { - "description": "Whether to show this column or not", - "example": 1, - "type": "number" - } - }, - "title": "Map Column Model", - "type": "object", - "x-stoplight": { - "id": "bvk0acuepoqw1" - } - }, - "Meta": { - "description": "Model for Meta", - "examples": [{}], - "oneOf": [ - { - "type": "null" - }, - { - "type": "object" - }, - { - "type": "string" - } - ], - "title": "Meta Model", - "x-stoplight": { - "id": "2ohjoms6hjcym" - } - }, - "ModelRoleVisibility": { - "description": "Model for ModelRoleVisibility", - "examples": [ - { - "base_id": "string", - "disabled": true, - "fk_model_id": "string", - "fk_view_id": "string", - "id": "string", - "project_id": "string", - "role": "string" - } - ], - "properties": { - "base_id": { - "type": "string" - }, - "disabled": { - "$ref": "#/components/schemas/Bool" - }, - "fk_model_id": { - "type": "string" - }, - "fk_view_id": { - "type": "string" - }, - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "project_id": { - "type": "string" - }, - "role": { - "type": "string" - } - }, - "title": "ModelRoleVisibility Model", - "type": "object", - "x-stoplight": { - "id": "68m1dblcswem2" - } - }, - "NormalColumnRequest": { - "description": "Model for Normal Column Request", - "examples": [ - { - "ai": true, - "au": true, - "cc": "string", - "cdf": "string", - "column_name": "string", - "csn": "string", - "dt": "string", - "dtx": "string", - "dtxp": 0, - "dtxs": 0, - "np": 0, - "ns": 0, - "pk": true, - "pv": true, - "rqd": true, - "title": "string", - "uidt": "ID", - "un": true, - "unique": true - } - ], - "properties": { - "ai": { - "$ref": "#/components/schemas/Bool", - "description": "Is this column auto-incremented?" - }, - "au": { - "$ref": "#/components/schemas/Bool", - "description": "Is this column auto-updated datetime field?" - }, - "cc": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Column Comment" - }, - "cdf": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Column Default Value" - }, - "column_name": { - "maxLength": 255, - "minLength": 1, - "type": "string", - "description": "Column Name" - }, - "csn": { - "$ref": "#/components/schemas/StringOrNull" - }, - "dt": { - "type": "string", - "description": "Data Type" - }, - "dtx": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Data Type Extra" - }, - "dtxp": { - "oneOf": [ - { - "$ref": "#/components/schemas/StringOrNull" - }, - { - "type": "number" - } - ], - "description": "Data Type Extra Precision" - }, - "dtxs": { - "oneOf": [ - { - "$ref": "#/components/schemas/StringOrNull" - }, - { - "type": "number" - } - ], - "description": "Data Type Extra Scale" - }, - "np": { - "oneOf": [ - { - "$ref": "#/components/schemas/StringOrNull" - }, - { - "type": "integer" - } - ], - "description": "Numeric Precision" - }, - "ns": { - "oneOf": [ - { - "$ref": "#/components/schemas/StringOrNull" - }, - { - "type": "integer" - } - ], - "description": "Numeric Scale" - }, - "pk": { - "$ref": "#/components/schemas/Bool", - "description": "Is this column a primary key?" - }, - "pv": { - "$ref": "#/components/schemas/Bool", - "description": "Is this column a primary value?" - }, - "rqd": { - "$ref": "#/components/schemas/Bool", - "description": "Is this column required?" - }, - "title": { - "maxLength": 255, - "type": "string", - "description": "Column Title" - }, - "uidt": { - "enum": [ - "Attachment", - "AutoNumber", - "Barcode", - "Button", - "Checkbox", - "Collaborator", - "Count", - "CreateTime", - "Currency", - "Date", - "DateTime", - "Decimal", - "Duration", - "Email", - "Formula", - "ForeignKey", - "GeoData", - "Geometry", - "ID", - "JSON", - "LastModifiedTime", - "LongText", - "LinkToAnotherRecord", - "Lookup", - "MultiSelect", - "Number", - "Percent", - "PhoneNumber", - "Rating", - "Rollup", - "SingleLineText", - "SingleSelect", - "SpecificDBType", - "Time", - "URL", - "Year", - "QrCode" - ], - "type": "string", - "description": "UI Data Type" - }, - "un": { - "$ref": "#/components/schemas/Bool", - "description": "Is this column unique?" - }, - "unique": { - "$ref": "#/components/schemas/Bool", - "description": "Is this column unique?" - } - }, - "title": "Normal Column Request Model", - "type": "object", - "required": ["column_name"], - "x-stoplight": { - "id": "b67hswwa49t9u" - } - }, - "OrgUserReq": { - "description": "Model for Organisation User Update Request", - "examples": [ - { - "email": "user@example.com", - "roles": "org-level-creator" - } - ], - "properties": { - "email": { - "format": "email", - "type": "string" - }, - "roles": { - "enum": ["org-level-creator", "org-level-viewer"], - "type": "string", - "description": "Roles for the project user" - } - }, - "title": "Organisation User Request Model", - "type": "object", - "x-stoplight": { - "id": "hs5aforkqjbkb" - } - }, - "Paginated": { - "description": "Model for Paginated", - "examples": [ - { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - ], - "properties": { - "isFirstPage": { - "description": "Is the current page the first page", - "type": "boolean" - }, - "isLastPage": { - "description": "Is the current page the last page", - "type": "boolean" - }, - "page": { - "description": "The current page", - "example": 1, - "type": "number" - }, - "pageSize": { - "description": "The number of pages", - "example": 10, - "type": "number" - }, - "totalRows": { - "description": "The number of rows in the given result", - "example": 1, - "type": "number" - } - }, - "title": "Paginated Model", - "type": "object", - "x-stoplight": { - "id": "ny0v2losvmitz" - } - }, - "Password": { - "description": "Model for Password", - "example": "password123456789", - "examples": ["password123456789"], - "minLength": 8, - "title": "Password Model", - "type": "string", - "x-stoplight": { - "id": "c6iocwuo2j8z8" - } - }, - "PasswordChangeReq": { - "description": "Model for Password Change Request", - "examples": [ - { - "currentPassword": "currentpassword", - "newPassword": "newpassword" - } - ], - "properties": { - "currentPassword": { - "type": "string" - }, - "newPassword": { - "minLength": 8, - "type": "string" - } - }, - "required": ["currentPassword", "newPassword"], - "title": "Password Change Request Model", - "type": "object", - "x-stoplight": { - "id": "99dogahvh0gla" - } - }, - "PasswordForgotReq": { - "description": "Model for Password Forgot Request", - "examples": [ - { - "email": "user@example.com" - } - ], - "properties": { - "email": { - "description": "Email address of the user", - "format": "email", - "type": "string" - } - }, - "required": ["email"], - "title": "Password Forgot Request Model", - "type": "object", - "x-stoplight": { - "id": "1kkft7m54ax45" - } - }, - "PasswordResetReq": { - "description": "Model for Password Reset Request", - "examples": [ - { - "password": "newpassword" - } - ], - "properties": { - "password": { - "description": "New password", - "example": "newpassword", - "minLength": 8, - "type": "string" - } - }, - "required": ["password"], - "title": "Password Reset Request Model", - "type": "object", - "x-stoplight": { - "id": "i3gzz403zjwh8" - } - }, - "Plugin": { - "description": "Model for Plugin", - "examples": [ - { - "id": "nc_tljibbzcyjrhcc", - "title": "S3", - "description": "Amazon Simple Storage Service (Amazon S3) is an object storage service that offers industry-leading scalability, data availability, security, and performance.", - "active": true, - "rating": null, - "version": "0.0.1", - "docs": null, - "status": "install", - "status_details": null, - "logo": "plugins/s3.png", - "icon": null, - "tags": "Storage", - "category": "Storage", - "input_schema": "{\"title\":\"Configure Amazon S3\",\"items\":[{\"key\":\"bucket\",\"label\":\"Bucket Name\",\"placeholder\":\"Bucket Name\",\"type\":\"SingleLineText\",\"required\":true},{\"key\":\"region\",\"label\":\"Region\",\"placeholder\":\"Region\",\"type\":\"SingleLineText\",\"required\":true},{\"key\":\"access_key\",\"label\":\"Access Key\",\"placeholder\":\"Access Key\",\"type\":\"SingleLineText\",\"required\":true},{\"key\":\"access_secret\",\"label\":\"Access Secret\",\"placeholder\":\"Access Secret\",\"type\":\"Password\",\"required\":true}],\"actions\":[{\"label\":\"Test\",\"placeholder\":\"Test\",\"key\":\"test\",\"actionType\":\"TEST\",\"type\":\"Button\"},{\"label\":\"Save\",\"placeholder\":\"Save\",\"key\":\"save\",\"actionType\":\"SUBMIT\",\"type\":\"Button\"}],\"msgOnInstall\":\"Successfully installed and attachment will be stored in AWS S3\",\"msgOnUninstall\":\"\"}", - "input": "{\"bucket\":\"my-bucket\",\"region\":\"us-west-004\",\"access_key\":\"redacted\",\"access_secret\":\"redacted\"}", - "creator": null, - "creator_website": null, - "price": null - } - ], - "title": "Plugin Model", - "type": "object", - "properties": { - "active": { - "$ref": "#/components/schemas/Bool", - "description": "Is plguin active?" - }, - "category": { - "type": "string", - "description": "Plugin Category", - "example": "Storage" - }, - "creator": { - "type": "string", - "description": "Plugin Creator (Not in use)" - }, - "creator_website": { - "type": "string", - "description": "Plugin Creator website (Not in use)" - }, - "description": { - "type": "string", - "description": "Plugin Description", - "example": "Amazon Simple Storage Service (Amazon S3) is an object storage service that offers industry-leading scalability, data availability, security, and performance." - }, - "docs": { - "type": "string", - "description": "Documentation of plugin (Not in use)" - }, - "icon": { - "type": "string", - "description": "Plugin Icon (Not in use)" - }, - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "input": { - "oneOf": [ - { - "$ref": "#/components/schemas/StringOrNull" - }, - { - "type": "integer" - } - ], - "description": "Plugin Input" - }, - "input_schema": { - "type": "string", - "description": "Plugin Input Schema\n" - }, - "logo": { - "type": "string", - "description": "Plugin logo", - "example": "plugins/s3.png" - }, - "price": { - "type": "string", - "description": "Plugin Price (Not in use)" - }, - "rating": { - "type": "number", - "description": "Plugin Rating (Not in use)" - }, - "status": { - "type": "string", - "description": "Plugin Status", - "example": "install" - }, - "status_details": { - "type": "string", - "description": "Not in use" - }, - "tags": { - "type": "string", - "description": "Plugin tags", - "example": "Storage" - }, - "title": { - "type": "string", - "description": "Plugin Title" - }, - "version": { - "type": "string", - "description": "Plugin Version", - "example": "0.0.1" - } - }, - "x-stoplight": { - "id": "uux5n95kbh2r5" - } - }, - "PluginReq": { - "description": "Model for Plugin Request", - "examples": [ - { - "active": 0, - "input": "{\"bucket\":\"my-bucket\",\"region\":\"us-west-004\",\"access_key\":\"redacted\",\"access_secret\":\"redacted\"}" - } - ], - "title": "Plugin Reqeust", - "type": "object", - "properties": { - "active": { - "$ref": "#/components/schemas/Bool", - "description": "Is Plugin Active?" - }, - "input": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Plugin Input" - } - }, - "x-stoplight": { - "id": "pci8zg4wgn3bx" - } - }, - "PluginTestReq": { - "description": "Model for Plugin Test Request", - "examples": [ - { - "title": "Plugin Foo", - "input": "{\"bucket\":\"my-bucket\",\"region\":\"us-west-004\",\"access_key\":\"redacted\",\"access_secret\":\"redacted\"}", - "category": "Email" - } - ], - "title": "Plugin Test Request Model", - "type": "object", - "properties": { - "title": { - "maxLength": 45, - "type": "string", - "description": "Plugin Title" - }, - "input": { - "oneOf": [ - { - "type": "string", - "description": "Plugin Input as JSON string" - }, - { - "description": "Plugin Input", - "type": "object" - } - ] - }, - "category": { - "x-stoplight": { - "id": "rg3i3ov9rs6d0" - }, - "type": "string", - "example": "Email" - } - }, - "required": ["title", "input", "category"], - "x-stoplight": { - "id": "gest5kbecpjdi" - } - }, - "Project": { - "description": "Model for Project", - "examples": [ - { - "bases": [ - { - "alias": "string", - "config": null, - "enabled": true, - "id": "string", - "inflection_column": "camelize", - "inflection_table": "camelize", - "is_meta": true, - "order": 1, - "project_id": "string", - "type": "mysql2", - "updated_at": "2023-03-01 14:27:36" - } - ], - "color": "#24716E", - "created_at": "2023-03-01 14:27:36", - "deleted": true, - "description": "This is my project description", - "id": "p_124hhlkbeasewh", - "is_meta": true, - "meta": {}, - "order": 0, - "prefix": "nc_vm5q__", - "status": "string", - "title": "my-project" - } - ], - "title": "Project Model", - "type": "object", - "properties": { - "bases": { - "description": "List of base models", - "type": "array", - "items": { - "$ref": "#/components/schemas/Base" - } - }, - "color": { - "description": "Primary Theme Color", - "example": "#24716E", - "type": "string" - }, - "deleted": { - "$ref": "#/components/schemas/Bool", - "description": "Is the project deleted" - }, - "description": { - "description": "Project Description", - "example": "This is my project description", - "type": "string" - }, - "id": { - "description": "Unique Project ID", - "example": "p_124hhlkbeasewh", - "type": "string" - }, - "is_meta": { - "$ref": "#/components/schemas/Bool" - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "description": "Meta Info such as theme colors" - }, - "order": { - "description": "The order in project list", - "type": "number" - }, - "prefix": { - "description": "Project prefix. Used in XCDB only.", - "example": "nc_vm5q__", - "type": "string" - }, - "status": { - "type": "string" - }, - "title": { - "description": "Project Title", - "example": "my-project", - "type": "string" - } - }, - "x-stoplight": { - "id": "gae6rj3whdnj9" - } - }, - "ProjectList": { - "description": "Model for Project List", - "examples": [ - { - "list": [ - { - "bases": [ - { - "alias": "string", - "config": null, - "created_at": "2023-03-01 14:27:36", - "enabled": true, - "id": "string", - "inflection_column": "camelize", - "inflection_table": "camelize", - "is_meta": true, - "order": 1, - "project_id": "string", - "type": "mysql2", - "updated_at": "2023-03-01 14:27:36" - } - ], - "color": "#24716E", - "created_at": "2023-03-01 14:27:36", - "deleted": true, - "description": "This is my project description", - "id": "p_124hhlkbeasewh", - "is_meta": true, - "meta": {}, - "order": 0, - "prefix": "nc_vm5q__", - "status": "string", - "title": "my-project", - "updated_at": "2023-03-01 14:27:36" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - ], - "title": "Project List Model", - "type": "object", - "x-examples": { - "example-1": { - "bases": { - "list": [ - { - "alias": "string", - "database": "string", - "host": "string", - "id": "string", - "params": "string", - "password": "string", - "port": 0, - "project_id": "string", - "ssl": "string", - "type": "string", - "url": "string", - "username": "string" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "pageSize": 0, - "sort": "string", - "totalRows": 0 - } - } - } - }, - "properties": { - "list": { - "description": "List of Project Models", - "minItems": 1, - "type": "array", - "uniqueItems": true, - "items": { - "$ref": "#/components/schemas/Project" - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated", - "description": "Pagination Info" - } - }, - "required": ["list", "pageInfo"], - "x-stoplight": { - "id": "xbosckfm1h9l0" - } - }, - "ProjectReq": { - "description": "Model for Project Request", - "examples": [ - { - "bases": [ - { - "alias": "My Base", - "config": null, - "inflection_column": "camelize", - "inflection_table": "camelize", - "is_meta": true, - "type": "mysql" - } - ], - "color": "#24716E", - "description": "This is my project description", - "title": "My Project" - } - ], - "properties": { - "bases": { - "description": "Array of Bases", - "items": { - "$ref": "#/components/schemas/BaseReq" - }, - "type": "array" - }, - "color": { - "description": "Primary Theme Color", - "example": "#24716E", - "maxLength": 50, - "type": "string" - }, - "description": { - "description": "Project Description", - "example": "This is my project description", - "type": "string" - }, - "title": { - "description": "Project Title", - "example": "My Project", - "maxLength": 128, - "minLength": 1, - "type": "string" - } - }, - "required": ["title"], - "title": "Project Request Model", - "type": "object", - "x-stoplight": { - "id": "aicbp4keo57ld" - } - }, - "ProjectUpdateReq": { - "description": "Model for Project Update Request", - "x-stoplight": { - "id": "83257b35r118q" - }, - "examples": [ - { - "color": "#24716E", - "meta": null, - "title": "My Project" - } - ], - "title": "Project Update Request Model", - "type": "object", - "properties": { - "color": { - "description": "Primary Theme Color", - "example": "#24716E", - "maxLength": 50, - "type": "string" - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "description": "Project Meta", - "x-stoplight": { - "id": "m05w9sbwqgul3" - } - }, - "title": { - "description": "Project Title", - "example": "My Project", - "maxLength": 128, - "minLength": 1, - "type": "string" - } - } - }, - "ProjectUserReq": { - "description": "Model for Project User Request", - "examples": [ - { - "email": "user@example.com", - "roles": "owner" - } - ], - "title": "Project User Request Model", - "type": "object", - "properties": { - "email": { - "format": "email", - "type": "string", - "description": "Project User Email" - }, - "roles": { - "enum": [ - "commenter", - "editor", - "guest", - "owner", - "viewer", - "creator" - ], - "type": "string", - "description": "Project User Role" - } - }, - "required": ["email", "roles"], - "x-stoplight": { - "id": "tq2wpd2agebjz" - } - }, - "Rollup": { - "description": "Model for Rollup", - "examples": [ - { - "id": "rl_kc19pbdkij8wly", - "fk_column_id": "cl_588b63mneri2yi", - "fk_relation_column_id": "cl_c09q6eu6hsvn4s", - "fk_rollup_column_id": "cl_m62i1vyl23n8co", - "rollup_function": "count" - } - ], - "title": "Rollup Model", - "type": "object", - "properties": { - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "fk_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Column" - }, - "fk_relation_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign to Relation Column" - }, - "fk_rollup_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign to Rollup Column" - }, - "rollup_function": { - "type": "string", - "description": "Rollup Function", - "example": "count", - "enum": [ - "count", - "min", - "max", - "avg", - "countDistinct", - "sumDistinct", - "avgDistinct" - ] - } - }, - "x-stoplight": { - "id": "vdzh0qojyn9a9" - } - }, - "RollupColumnReq": { - "description": "Model for Rollup Column Request", - "examples": [ - { - "fk_relation_column_id": "cl_c09q6eu6hsvn4s", - "fk_rollup_column_id": "cl_m62i1vyl23n8co", - "title": "Rollup Column", - "rollup_function": "avg", - "uidt": "Rollup" - } - ], - "title": "Rollup Column Request Model", - "type": "object", - "properties": { - "fk_relation_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Relation Column" - }, - "fk_rollup_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Rollup Column" - }, - "title": { - "maxLength": 255, - "type": "string", - "description": "Rollup Column Title" - }, - "rollup_function": { - "enum": [ - "avg", - "avgDistinct", - "count", - "countDistinct", - "max", - "min", - "sum", - "sumDistinct" - ], - "type": "string", - "description": "Rollup Function" - }, - "uidt": { - "enum": ["Rollup"], - "type": "string", - "description": "UI DataType" - } - }, - "x-stoplight": { - "id": "uw9fq6lp1lone" - } - }, - "SelectOption": { - "description": "Model for SelectOption", - "examples": [ - { - "id": "sl_hvfeuagqtlzzbk", - "title": "Option A", - "fk_column_id": "cl_35zmvi2tezfipw", - "color": "#cfdffe", - "order": 1 - } - ], - "title": "SelectOption Model", - "type": "object", - "properties": { - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "title": { - "type": "string", - "description": "Option Title\n", - "example": "Option A" - }, - "fk_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Column" - }, - "color": { - "type": "string", - "description": "Option Color", - "example": "#cfdffe" - }, - "order": { - "type": "number", - "description": "The order among the options", - "example": 1 - } - }, - "x-stoplight": { - "id": "onnh5qie1ul32" - } - }, - "SelectOptions": { - "description": "Model for SelectOptions", - "examples": [ - { - "options": [ - { - "id": "sl_hvfeuagqtlzzbk", - "title": "Option A", - "fk_column_id": "cl_35zmvi2tezfipw", - "color": "#cfdffe", - "order": 1 - } - ] - } - ], - "title": "SelectOptions Model", - "type": "object", - "properties": { - "options": { - "type": "array", - "description": "Array of select options", - "items": { - "$ref": "#/components/schemas/SelectOption" - } - } - }, - "required": ["options"], - "x-stoplight": { - "id": "3i68n0spduuf9" - } - }, - "SharedBaseReq": { - "description": "Model for Shared Base Request", - "examples": [ - { - "password": "password123", - "roles": "editor" - } - ], - "title": "Shared Base Request Model", - "type": "object", - "properties": { - "password": { - "minLength": 8, - "type": "string", - "description": "Password to protect the base", - "example": "password123" - }, - "roles": { - "enum": ["commenter", "editor", "viewer"], - "type": "string", - "description": "The role given the target user", - "example": "editor" - } - }, - "x-stoplight": { - "id": "ep7ikmx3sudcl" - } - }, - "SharedView": { - "$ref": "#/components/schemas/View", - "description": "Model for Shared View", - "title": "SharedView", - "examples": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:46:31", - "fk_model_id": "md_mhs9z4r2ak98x0", - "id": "vw_lg052cnc1c26kf", - "is_default": 1, - "lock_type": "collaborative", - "meta": {}, - "order": 1, - "password": null, - "project_id": "p_xm3thidrblw4n7", - "show": 1, - "show_system_fields": null, - "title": "Sheet-1", - "type": 3, - "updated_at": "2023-03-02 17:46:31", - "uuid": null, - "view": { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:46:31", - "fk_view_id": "vw_lg052cnc1c26kf", - "meta": null, - "project_id": "p_xm3thidrblw4n7", - "row_height": null, - "updated_at": "2023-03-02 17:46:31", - "uuid": null - } - } - ], - "x-stoplight": { - "id": "fqfohevz2zj4u" - } - }, - "SharedViewList": { - "description": "Model for Shared View List", - "examples": [ - { - "list": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:46:31", - "fk_model_id": "md_mhs9z4r2ak98x0", - "id": "vw_lg052cnc1c26kf", - "is_default": 1, - "lock_type": "collaborative", - "meta": {}, - "order": 1, - "password": null, - "project_id": "p_xm3thidrblw4n7", - "show": 1, - "show_system_fields": null, - "title": "Sheet-1", - "type": 3, - "updated_at": "2023-03-02 17:46:31", - "uuid": null, - "view": { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:46:31", - "fk_view_id": "vw_lg052cnc1c26kf", - "meta": null, - "project_id": "p_xm3thidrblw4n7", - "row_height": null, - "updated_at": "2023-03-02 17:46:31", - "uuid": null - } - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - ], - "title": "Shared View List Model", - "type": "object", - "x-examples": { - "example-1": { - "bases": { - "list": [ - { - "alias": "string", - "database": "string", - "host": "string", - "id": "string", - "params": "string", - "password": "string", - "port": 0, - "project_id": "string", - "ssl": "string", - "type": "string", - "url": "string", - "username": "string" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "pageSize": 0, - "sort": "string", - "totalRows": 0 - } - } - } - }, - "properties": { - "list": { - "minItems": 1, - "type": "array", - "uniqueItems": true, - "description": "List of shared view objects", - "items": { - "$ref": "#/components/schemas/SharedView" - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated", - "description": "Paginated Info" - } - }, - "required": ["list", "pageInfo"], - "x-stoplight": { - "id": "zdpekhmw0wvj3" - } - }, - "SharedViewReq": { - "description": "Model for Shared View Request", - "examples": [ - { - "meta": {}, - "password": "123456789" - } - ], - "title": "Shared View Request Model", - "type": "object", - "properties": { - "meta": { - "$ref": "#/components/schemas/Meta", - "description": "Meta data passing to Shared View such as if download is allowed or not." - }, - "password": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Password to restrict access" - } - }, - "x-stoplight": { - "id": "0g3o2uo9y4h4g" - } - }, - "SignInReq": { - "description": "Model for Signin Request", - "examples": [ - { - "email": "user@example.com", - "password": "string" - } - ], - "properties": { - "email": { - "description": "Email address of the user", - "format": "email", - "type": "string" - }, - "password": { - "description": "Password of the user", - "type": "string" - } - }, - "required": ["email", "password"], - "title": "Signin Request Model", - "type": "object", - "x-stoplight": { - "id": "dxxafjky40cz1" - } - }, - "SignUpReq": { - "description": "Model for Signup Request", - "examples": [ - { - "email": "user@example.com", - "password": "password123456789", - "firstname": "Alice", - "lastname": "Smith", - "token": null, - "ignore_subscribe": 0 - } - ], - "title": "Signup Request Model", - "type": "object", - "properties": { - "email": { - "description": "Email address of the user", - "example": "user@example.com", - "format": "email", - "type": "string" - }, - "password": { - "description": "Password of the user", - "example": "password123456789", - "minLength": 8, - "type": "string" - }, - "firstname": { - "$ref": "#/components/schemas/StringOrNull", - "x-stoplight": { - "id": "lblivgs8wcsm1" - } - }, - "lastname": { - "$ref": "#/components/schemas/StringOrNull", - "x-stoplight": { - "id": "d4341r35tucq3" - } - }, - "token": { - "$ref": "#/components/schemas/StringOrNull", - "x-stoplight": { - "id": "otw9jgnr9n7c4" - }, - "description": "Sign Up Token. Used for invitation." - }, - "ignore_subscribe": { - "$ref": "#/components/schemas/Bool", - "x-stoplight": { - "id": "g7ge6mc6vdsds" - }, - "description": "Ignore Subscription" - } - }, - "required": ["email", "password"], - "x-stoplight": { - "id": "2rcbk0flkc4yu" - } - }, - "Sort": { - "description": "Model for Sort", - "examples": [ - { - "id": "so_xd4t51uv60ghzl", - "fk_column_id": "cl_l11b769pe2j1ce", - "fk_model_id": "md_ehn5izr99m7d45", - "base_id": "ds_3l9qx8xqksenrl", - "direction": "desc", - "order": 1, - "project_id": "p_9sx43moxhqtjm3" - } - ], - "title": "Sort Model", - "type": "object", - "properties": { - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID" - }, - "fk_column_id": { - "$ref": "#/components/schemas/Id" - }, - "fk_model_id": { - "$ref": "#/components/schemas/Id" - }, - "base_id": { - "type": "string", - "description": "Base ID", - "example": "ds_3l9qx8xqksenrl", - "readOnly": true - }, - "direction": { - "type": "string", - "description": "Sort direction", - "enum": ["asc", "desc"], - "example": "desc" - }, - "order": { - "type": "number", - "example": 1 - }, - "project_id": { - "type": "string", - "description": "Project ID", - "example": "p_9sx43moxhqtjm3", - "readOnly": true - } - }, - "x-stoplight": { - "id": "3jjbe2mjzy5li" - } - }, - "SortList": { - "description": "Model for Sort List", - "examples": [ - { - "list": [ - { - "id": "so_xd4t51uv60ghzl", - "fk_column_id": "cl_l11b769pe2j1ce", - "fk_model_id": "md_ehn5izr99m7d45", - "base_id": "ds_3l9qx8xqksenrl", - "direction": "desc", - "order": 1, - "project_id": "p_9sx43moxhqtjm3" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - ], - "title": "Sort List Model", - "type": "object", - "x-examples": { - "example-1": { - "bases": { - "list": [ - { - "alias": "string", - "database": "string", - "host": "string", - "id": "string", - "params": "string", - "password": "string", - "port": 0, - "project_id": "string", - "ssl": "string", - "type": "string", - "url": "string", - "username": "string" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "pageSize": 0, - "sort": "string", - "totalRows": 0 - } - } - } - }, - "properties": { - "list": { - "type": "array", - "x-stoplight": { - "id": "gjqqc8ciqg947" - }, - "description": "List of Sort Objects", - "items": { - "$ref": "#/components/schemas/Sort", - "x-stoplight": { - "id": "usnfa1kbovpmb" - } - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated", - "x-stoplight": { - "id": "i75wcejfp5mnq" - } - } - }, - "required": ["list", "pageInfo"], - "x-stoplight": { - "id": "fsq6d3pi8b3iz" - } - }, - "SortReq": { - "description": "Model for Sort Request", - "examples": [ - { - "direction": "asc", - "fk_column_id": "cl_l11b769pe2j1ce" - } - ], - "minProperties": 1, - "title": "Sort Request Model", - "type": "object", - "properties": { - "fk_column_id": { - "$ref": "#/components/schemas/Id", - "description": "Foreign Key to Column" - }, - "direction": { - "description": "Sort direction", - "enum": ["asc", "desc"], - "type": "string" - } - }, - "x-stoplight": { - "id": "lao7jfow2dbe7" - } - }, - "StringOrNull": { - "description": "Model for StringOrNull", - "examples": ["string"], - "oneOf": [ - { - "maxLength": 255, - "type": "string" - }, - { - "type": "null" - } - ], - "title": "StringOrNull Model", - "x-stoplight": { - "id": "xh9dwrizrvfh6" - } - }, - "Table": { - "description": "Model for Table", - "examples": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "columns": [ - { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": "CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP", - "clen": null, - "column_name": "updated_at", - "cop": "4", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "timestamp", - "deleted": null, - "dt": "timestamp", - "dtx": "specificType", - "dtxp": "0", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_m4wkaqgqqjzoeh", - "meta": null, - "np": null, - "ns": null, - "order": 4, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 0, - "system": 0, - "title": "UpdatedAt", - "uidt": "DateTime", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": "CURRENT_TIMESTAMP", - "clen": null, - "column_name": "created_at", - "cop": "3", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "timestamp", - "deleted": null, - "dt": "timestamp", - "dtx": "specificType", - "dtxp": "0", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_jpl0qu4gj4rexq", - "meta": null, - "np": null, - "ns": null, - "order": 3, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 0, - "system": 0, - "title": "CreatedAt", - "uidt": "DateTime", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": null, - "clen": "45", - "column_name": "title", - "cop": "2", - "created_at": "2023-03-02 17:04:06", - "csn": "utf8mb4", - "ct": "varchar(45)", - "deleted": null, - "dt": "varchar", - "dtx": "specificType", - "dtxp": "45", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_c5knoi4xs4sfpt", - "meta": null, - "np": null, - "ns": null, - "order": 2, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": 1, - "rqd": 0, - "system": 0, - "title": "Title", - "uidt": "SingleLineText", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - { - "ai": 1, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": null, - "clen": null, - "column_name": "id", - "cop": "1", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "int unsigned", - "deleted": null, - "dt": "int", - "dtx": "specificType", - "dtxp": "", - "dtxs": "0", - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_phvuuwjrzcdo0g", - "meta": null, - "np": "10", - "ns": "0", - "order": 1, - "pk": 1, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 1, - "system": 0, - "title": "Id", - "uidt": "ID", - "un": 1, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - } - ], - "columnsById": { - "cl_c5knoi4xs4sfpt": { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": null, - "clen": "45", - "column_name": "title", - "cop": "2", - "created_at": "2023-03-02 17:04:06", - "csn": "utf8mb4", - "ct": "varchar(45)", - "deleted": null, - "dt": "varchar", - "dtx": "specificType", - "dtxp": "45", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_c5knoi4xs4sfpt", - "meta": null, - "np": null, - "ns": null, - "order": 2, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": 1, - "rqd": 0, - "system": 0, - "title": "Title", - "uidt": "SingleLineText", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - "cl_jpl0qu4gj4rexq": { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": "CURRENT_TIMESTAMP", - "clen": null, - "column_name": "created_at", - "cop": "3", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "timestamp", - "deleted": null, - "dt": "timestamp", - "dtx": "specificType", - "dtxp": "0", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_jpl0qu4gj4rexq", - "meta": null, - "np": null, - "ns": null, - "order": 3, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 0, - "system": 0, - "title": "CreatedAt", - "uidt": "DateTime", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - "cl_m4wkaqgqqjzoeh": { - "ai": 0, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": "CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP", - "clen": null, - "column_name": "updated_at", - "cop": "4", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "timestamp", - "deleted": null, - "dt": "timestamp", - "dtx": "specificType", - "dtxp": "0", - "dtxs": null, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_m4wkaqgqqjzoeh", - "meta": null, - "np": null, - "ns": null, - "order": 4, - "pk": 0, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 0, - "system": 0, - "title": "UpdatedAt", - "uidt": "DateTime", - "un": 0, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - }, - "cl_phvuuwjrzcdo0g": { - "ai": 1, - "au": 0, - "base_id": "ds_g4ccx6e77h1dmi", - "cc": "", - "cdf": null, - "clen": null, - "column_name": "id", - "cop": "1", - "created_at": "2023-03-02 17:04:06", - "csn": null, - "ct": "int unsigned", - "deleted": null, - "dt": "int", - "dtx": "specificType", - "dtxp": "", - "dtxs": "0", - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "cl_phvuuwjrzcdo0g", - "meta": null, - "np": "10", - "ns": "0", - "order": 1, - "pk": 1, - "project_id": "p_xm3thidrblw4n7", - "pv": null, - "rqd": 1, - "system": 0, - "title": "Id", - "uidt": "ID", - "un": 1, - "unique": 0, - "updated_at": "2023-03-02 17:04:06", - "validate": null, - "virtual": null - } - }, - "created_at": "2023-03-02 17:04:06", - "deleted": null, - "enabled": 1, - "id": "md_rsu68aqjsbyqtl", - "meta": null, - "mm": 0, - "order": 1, - "pinned": null, - "project_id": "p_xm3thidrblw4n7", - "schema": null, - "table_name": "nc_vm5q___Table1", - "tags": null, - "title": "Table1", - "type": "table", - "updated_at": "2023-03-02 17:04:08", - "views": [ - { - "_ptn": "Table1", - "_tn": "Table1", - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:04:06", - "disabled": { - "commenter": false, - "creator": false, - "editor": false, - "guest": false, - "owner": false, - "viewer": false - }, - "fk_model_id": "md_rsu68aqjsbyqtl", - "id": "vw_p2jcatxz4mvcfw", - "is_default": 1, - "lock_type": "collaborative", - "meta": {}, - "order": 1, - "password": null, - "project_id": "p_xm3thidrblw4n7", - "ptn": "nc_vm5q___Table1", - "ptype": "table", - "show": 1, - "show_system_fields": null, - "table_meta": null, - "title": "Table1", - "tn": "Table1", - "type": 3, - "updated_at": "2023-03-02 17:04:06", - "uuid": null, - "view": { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:04:06", - "fk_view_id": "vw_p2jcatxz4mvcfw", - "meta": null, - "project_id": "p_xm3thidrblw4n7", - "row_height": null, - "updated_at": "2023-03-02 17:04:06", - "uuid": null - } - } - ] - } - ], - "title": "Table Model", - "type": "object", - "properties": { - "base_id": { - "description": "Unique Base ID", - "type": "string" - }, - "columns": { - "description": "The columns included in this table", - "type": "array", - "items": { - "$ref": "#/components/schemas/Column" - } - }, - "columnsById": { - "description": "Column Models grouped by IDs", - "type": "object" - }, - "deleted": { - "$ref": "#/components/schemas/Bool" - }, - "enabled": { - "$ref": "#/components/schemas/Bool", - "description": "Is this table enabled?" - }, - "id": { - "description": "Unique Table ID", - "type": "string" - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "description": "Meta Data" - }, - "mm": { - "$ref": "#/components/schemas/Bool", - "description": "Is this table used for M2M" - }, - "order": { - "description": "The order of the list of tables", - "type": "number" - }, - "pinned": { - "$ref": "#/components/schemas/Bool", - "description": "Currently not in use" - }, - "project_id": { - "description": "Unique Project ID", - "type": "string" - }, - "table_name": { - "description": "Table Name. Prefix will be added for XCDB projects.", - "type": "string" - }, - "tags": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Currently not in use" - }, - "title": { - "description": "Table Title", - "type": "string" - }, - "type": { - "description": "Table Type", - "type": "string" - } - }, - "required": ["table_name", "title"], - "x-stoplight": { - "id": "rvdu5okgpz1xk" - } - }, - "TableList": { - "description": "Model for Table List", - "examples": [ - { - "list": [ - { - "alias": "string", - "base_id": "string", - "column": [ - { - "alias": "string", - "auto_increment": true, - "auto_update_timestamp": true, - "base_id": "string", - "character_maximum_length": "string", - "character_set_name": "string", - "colOptions": { - "deleted": "string", - "dr": "string", - "fk_child_column_id": "string", - "fk_column_id": "string", - "fk_index_name": "string", - "fk_mm_child_column_id": "string", - "fk_mm_model_id": "string", - "fk_mm_parent_column_id": "string", - "fk_parent_column_id": "string", - "id": "string", - "order": "string", - "type": "string", - "ur": "string", - "virtual": true - }, - "column_comment": "string", - "column_default": "string", - "column_ordinal_position": "string", - "column_type": "string", - "data_type": "string", - "data_type_x": "string", - "data_type_x_precision": "string", - "data_type_x_scale": "string", - "deleted": true, - "fk_model_id": "string", - "id": "string", - "numeric_precision": "string", - "numeric_scale": "string", - "order": 0, - "primary_key": true, - "primary_value": true, - "rqd": "string", - "title": "string", - "ui_data_type": "string", - "un": "string", - "unique": true, - "visible": true - } - ], - "columnByIds": {}, - "deleted": true, - "enabled": true, - "id": "string", - "order": 0, - "parent_id": "string", - "pinned": true, - "project_id": "string", - "show_as": "string", - "tags": "string", - "title": "string", - "type": "string" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - ], - "title": "Table List Model", - "type": "object", - "x-examples": { - "example-1": { - "bases": { - "list": [ - { - "alias": "string", - "database": "string", - "host": "string", - "id": "string", - "params": "string", - "password": "string", - "port": 0, - "project_id": "string", - "ssl": "string", - "type": "string", - "url": "string", - "username": "string" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "pageSize": 0, - "sort": "string", - "totalRows": 0 - } - } - } - }, - "properties": { - "list": { - "minItems": 1, - "type": "array", - "uniqueItems": true, - "description": "List of table objects", - "items": { - "$ref": "#/components/schemas/Table" - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated", - "description": "Paginated Info" - } - }, - "required": ["list", "pageInfo"], - "x-stoplight": { - "id": "25z7dodhqs3lc" - } - }, - "TableReq": { - "description": "Model for Table Request", - "examples": [ - { - "columns": [ - { - "ai": false, - "altered": 1, - "cdf": "CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP", - "ck": false, - "clen": 45, - "column_name": "updated_at", - "ct": "varchar(45)", - "dt": "timestamp", - "dtx": "specificType", - "dtxp": "", - "dtxs": "", - "np": null, - "nrqd": true, - "ns": null, - "pk": false, - "rqd": false, - "title": "UpdatedAt", - "uicn": "", - "uidt": "DateTime", - "uip": "", - "un": false - }, - { - "ai": false, - "altered": 1, - "cdf": "CURRENT_TIMESTAMP", - "ck": false, - "clen": 45, - "column_name": "created_at", - "ct": "varchar(45)", - "dt": "timestamp", - "dtx": "specificType", - "dtxp": "", - "dtxs": "", - "np": null, - "nrqd": true, - "ns": null, - "pk": false, - "rqd": false, - "title": "CreatedAt", - "uicn": "", - "uidt": "DateTime", - "uip": "", - "un": false - }, - { - "ai": false, - "altered": 1, - "cdf": null, - "ck": false, - "clen": 45, - "column_name": "title", - "ct": "varchar(45)", - "dt": "varchar", - "dtx": "specificType", - "dtxp": "45", - "dtxs": "", - "np": null, - "nrqd": true, - "ns": null, - "pk": false, - "rqd": false, - "title": "Title", - "uicn": "", - "uidt": "SingleLineText", - "uip": "", - "un": false - }, - { - "ai": true, - "altered": 1, - "cdf": null, - "ck": false, - "clen": null, - "column_name": "id", - "ct": "int(11)", - "dt": "int", - "dtx": "integer", - "dtxp": "11", - "dtxs": "", - "np": 11, - "nrqd": false, - "ns": 0, - "pk": true, - "rqd": true, - "title": "Id", - "uicn": "", - "uidt": "ID", - "uip": "", - "un": true - } - ], - "table_name": "Sheet-1", - "title": "Sheet-1" - } - ], - "properties": { - "columns": { - "description": "The column models in this table", - "items": { - "$ref": "#/components/schemas/NormalColumnRequest" - }, - "type": "array" - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "description": "the meta data for this table" - }, - "order": { - "description": "The order of table list", - "example": 1, - "type": "number" - }, - "table_name": { - "description": "Table name", - "example": "my_table", - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "title": { - "description": "Table title", - "example": "My Table", - "maxLength": 255, - "minLength": 0, - "type": "string" - } - }, - "required": ["columns", "table_name"], - "title": "Table Request Model", - "type": "object", - "x-stoplight": { - "id": "kilqakhuuzstv" - } - }, - "User": { - "description": "Model for User", - "examples": [ - { - "email": "user@example.com", - "email_verified": true, - "firstname": "Alice", - "id": "us_8kugj628ebjngs", - "lastname": "Smith", - "roles": "org-level-viewer" - } - ], - "title": "User Model", - "type": "object", - "x-internal": false, - "properties": { - "email": { - "description": "The email of the user", - "example": "user@example.com", - "format": "email", - "type": "string" - }, - "email_verified": { - "description": "Set to true if the user's email has been verified.", - "type": "boolean" - }, - "firstname": { - "description": "The first name of the user", - "example": "Alice", - "type": "string" - }, - "id": { - "description": "Unique identifier for the given user.", - "example": "us_8kugj628ebjngs", - "type": "string" - }, - "lastname": { - "description": "The last name of the user", - "example": "Smith", - "type": "string" - }, - "roles": { - "description": "The roles of the user", - "example": "org-level-viewer", - "type": "string" - } - }, - "required": ["email", "email_verified", "firstname", "id", "lastname"], - "x-stoplight": { - "id": "nwug6wvbc5yrp" - } - }, - "UserInfo": { - "description": "Model for User Info", - "examples": [ - { - "email": "user@example.com", - "email_verified": true, - "firstname": "string", - "id": "string", - "lastname": "string", - "roles": null - } - ], - "properties": { - "email": { - "description": "User Email", - "format": "email", - "type": "string" - }, - "email_verified": { - "description": "Set to true if the user's email has been verified.", - "type": "boolean" - }, - "firstname": { - "description": "The firstname of the user", - "type": "string" - }, - "id": { - "description": "User ID", - "type": "string" - }, - "lastname": { - "description": "The lastname of the user", - "type": "string" - }, - "roles": { - "description": "The roles of the user" - } - }, - "title": "User Info Model", - "type": "object", - "x-stoplight": { - "id": "qravubcoxvr6x" - } - }, - "UserList": { - "description": "Model for User List", - "examples": [ - { - "list": [ - { - "email": "user@example.com", - "email_verified": true, - "firstname": "Alice", - "id": "us_8kugj628ebjngs", - "lastname": "Smith", - "roles": "org-level-viewer" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - ], - "title": "User List Model", - "type": "object", - "x-examples": { - "example-1": { - "bases": { - "list": [ - { - "alias": "string", - "database": "string", - "host": "string", - "id": "string", - "params": "string", - "password": "string", - "port": 0, - "project_id": "string", - "ssl": "string", - "type": "string", - "url": "string", - "username": "string" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "pageSize": 0, - "sort": "string", - "totalRows": 0 - } - } - } - }, - "properties": { - "list": { - "type": "array", - "x-stoplight": { - "id": "8o7v47q3e67ef" - }, - "description": "List of user objects", - "items": { - "$ref": "#/components/schemas/User", - "x-stoplight": { - "id": "kwqzxwea9r5er" - } - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated", - "x-stoplight": { - "id": "0d98n6sfxfvft" - }, - "description": "Paginated Info" - } - }, - "required": ["list", "pageInfo"], - "x-stoplight": { - "id": "11epslmm9jcga" - } - }, - "View": { - "description": "Model for View", - "examples": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:46:31", - "fk_model_id": "md_mhs9z4r2ak98x0", - "id": "vw_lg052cnc1c26kf", - "is_default": 1, - "lock_type": "collaborative", - "meta": {}, - "order": 1, - "password": null, - "project_id": "p_xm3thidrblw4n7", - "show": 1, - "show_system_fields": null, - "title": "Sheet-1", - "type": 3, - "updated_at": "2023-03-02 17:46:31", - "uuid": null, - "view": { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:46:31", - "fk_view_id": "vw_lg052cnc1c26kf", - "meta": null, - "project_id": "p_xm3thidrblw4n7", - "row_height": null, - "updated_at": "2023-03-02 17:46:31", - "uuid": null - } - } - ], - "title": "View Model", - "type": "object", - "properties": { - "base_id": { - "$ref": "#/components/schemas/Id", - "description": "Unique Base ID" - }, - "fk_model_id": { - "$ref": "#/components/schemas/Id", - "description": "Unique Model ID" - }, - "id": { - "$ref": "#/components/schemas/Id", - "description": "Unique ID for View" - }, - "lock_type": { - "description": "Lock Type of the view", - "enum": ["collaborative", "locked", "personal"], - "type": "string" - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "description": "Meta data for this view" - }, - "order": { - "description": "The rder of the list of views", - "type": "number" - }, - "password": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Password for protecting the view" - }, - "project_id": { - "$ref": "#/components/schemas/Id", - "description": "Unique Project ID" - }, - "show": { - "$ref": "#/components/schemas/Bool", - "description": "If this view is shown?" - }, - "show_system_fields": { - "$ref": "#/components/schemas/Bool", - "description": "Should show system fields in this view?" - }, - "is_default": { - "$ref": "#/components/schemas/Bool", - "description": "Is this view default view for the model?" - }, - "title": { - "description": "View Title", - "type": "string" - }, - "type": { - "description": "View Type", - "type": "number" - }, - "uuid": { - "$ref": "#/components/schemas/StringOrNull", - "description": "UUID of the view" - }, - "view": { - "anyOf": [ - { - "$ref": "#/components/schemas/Form" - }, - { - "$ref": "#/components/schemas/Gallery" - }, - { - "$ref": "#/components/schemas/Grid" - }, - { - "$ref": "#/components/schemas/Kanban" - }, - { - "$ref": "#/components/schemas/Map" - } - ], - "description": "Associated View Model" - } - }, - "required": ["fk_model_id", "show", "title", "type"], - "x-stoplight": { - "id": "pbahdgaroikdz" - } - }, - "ViewList": { - "description": "Model for View List", - "examples": [ - { - "list": [ - { - "alias": "string", - "column": [ - { - "alias": "string", - "auto_increment": true, - "auto_update_timestamp": true, - "base_id": "string", - "character_maximum_length": "string", - "character_set_name": "string", - "colOptions": { - "deleted": "string", - "dr": "string", - "fk_child_column_id": "string", - "fk_column_id": "string", - "fk_index_name": "string", - "fk_mm_child_column_id": "string", - "fk_mm_model_id": "string", - "fk_mm_parent_column_id": "string", - "fk_parent_column_id": "string", - "id": "string", - "order": "string", - "type": "string", - "ur": "string", - "virtual": true - }, - "column_comment": "string", - "column_default": "string", - "column_ordinal_position": "string", - "column_type": "string", - "data_type": "string", - "data_type_x": "string", - "data_type_x_precision": "string", - "data_type_x_scale": "string", - "deleted": true, - "fk_model_id": "string", - "id": "string", - "numeric_precision": "string", - "numeric_scale": "string", - "order": 0, - "primary_key": true, - "primary_value": true, - "rqd": "string", - "title": "string", - "ui_data_type": "string", - "un": "string", - "unique": true, - "visible": true - } - ], - "columnByIds": {}, - "deleted": true, - "enabled": true, - "fk_base_id": "string", - "fk_project_id": "string", - "id": "string", - "order": 0, - "parent_id": "string", - "pinned": true, - "show_as": "string", - "tags": "string", - "title": "string", - "type": "string" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - ], - "title": "View List Model", - "type": "object", - "x-examples": { - "example-1": { - "bases": { - "list": [ - { - "alias": "string", - "database": "string", - "host": "string", - "id": "string", - "params": "string", - "password": "string", - "port": 0, - "project_id": "string", - "ssl": "string", - "type": "string", - "url": "string", - "username": "string" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "pageSize": 0, - "sort": "string", - "totalRows": 0 - } - } - } - }, - "properties": { - "list": { - "type": "array", - "description": "List of view objects", - "items": { - "$ref": "#/components/schemas/View" - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated", - "description": "Paginated Info" - } - }, - "required": ["list", "pageInfo"], - "x-stoplight": { - "id": "5wwtppugkhbeh" - } - }, - "ViewCreateReq": { - "type": "object", - "x-stoplight": { - "id": "lksv99846uy60" - }, - "title": "ViewCreateReq", - "description": "Model for View Create Request", - "examples": [ - { - "title": "My Grid View", - "type": 3, - "copy_from_id": null, - "fk_grp_col_id": null, - "fk_geo_data_col_id": null - }, - { - "title": "My Gallery View", - "type": 2, - "copy_from_id": null, - "fk_grp_col_id": null, - "fk_geo_data_col_id": null - }, - { - "title": "My Form View", - "type": 1, - "copy_from_id": null, - "fk_grp_col_id": null, - "fk_geo_data_col_id": null - }, - { - "title": "My Kanban View", - "type": 4, - "copy_from_id": null, - "fk_grp_col_id": "cl_g0a89q9xdry3lu", - "fk_geo_data_col_id": null - }, - { - "title": "My Map View", - "type": 5, - "copy_from_id": null, - "fk_grp_col_id": null, - "fk_geo_data_col_id": "cl_uu1meolj00tlrq" - } - ], - "properties": { - "title": { - "type": "string", - "description": "View Title", - "example": "My View" - }, - "type": { - "type": "number", - "description": "View Type" - }, - "copy_from_id": { - "$ref": "#/components/schemas/StringOrNull", - "description": "ID of view to be copied from. Used in Copy View." - }, - "fk_grp_col_id": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Foreign Key to Grouping Column. Used in creating Kanban View." - }, - "fk_geo_data_col_id": { - "$ref": "#/components/schemas/StringOrNull", - "description": "Foreign Key to Geo Data Column. Used in creating Map View." - } - }, - "required": ["title"] - }, - "ViewUpdateReq": { - "description": "Model for View Update Request", - "x-stoplight": { - "id": "1enlswadfc6p5" - }, - "examples": [ - { - "title": "Grid View 1", - "uuid": "e2457bbf-e29c-4fec-866e-fe3b01dba57f", - "password": "password123", - "lock_type": "collaborative", - "meta": "{\"allowCSVDownload\":true}", - "order": 1, - "show_system_fields": 0 - } - ], - "title": "View Update Request Model", - "type": "object", - "properties": { - "title": { - "maxLength": 255, - "type": "string", - "description": "View Title", - "example": "Grid View 1" - }, - "uuid": { - "maxLength": 255, - "type": "string", - "x-stoplight": { - "id": "vlhs7xs644u8l" - }, - "description": "View UUID. Used in Shared View.", - "example": "e2457bbf-e29c-4fec-866e-fe3b01dba57f" - }, - "password": { - "maxLength": 255, - "type": "string", - "x-stoplight": { - "id": "vlhs7xs644u8l" - }, - "description": "View Password. Used in Shared View.", - "example": "password123" - }, - "lock_type": { - "enum": ["collaborative", "locked", "personal"], - "type": "string", - "description": "Lock type of View.", - "example": "collaborative" - }, - "meta": { - "$ref": "#/components/schemas/Meta", - "description": "Meta info used in View." - }, - "order": { - "type": "number", - "description": "The order of the list of views.", - "example": 1, - "minimum": 0 - }, - "show_system_fields": { - "$ref": "#/components/schemas/Bool", - "description": "Should this view show system fields?" - } - } - }, - "ViewColumnUpdateReq": { - "description": "Model for View Column Update Request", - "x-stoplight": { - "id": "ifzuv29axterb" - }, - "examples": [ - { - "show": 0, - "order": 1 - } - ], - "title": "View Column Update Request Model", - "type": "object", - "properties": { - "show": { - "$ref": "#/components/schemas/Bool", - "description": "View Title", - "x-stoplight": { - "id": "coxius73ejq5x" - } - }, - "order": { - "type": "number", - "description": "The order of the list of views.", - "example": 1, - "minimum": 0 - } - } - }, - "ViewColumnReq": { - "description": "Model for View Column Request", - "x-stoplight": { - "id": "z4bq84nyqkhd8" - }, - "examples": [ - { - "fk_column_id": "cl_5jestblzneb649", - "show": 0, - "order": 1 - } - ], - "title": "View Column Request Model", - "type": "object", - "properties": { - "fk_column_id": { - "$ref": "#/components/schemas/Id", - "x-stoplight": { - "id": "rxd07wvp9hf6s" - }, - "description": "Foreign Key to Column" - }, - "show": { - "$ref": "#/components/schemas/Bool", - "description": "View Title", - "x-stoplight": { - "id": "coxius73ejq5x" - } - }, - "order": { - "type": "number", - "description": "The order of the list of views.", - "example": 1, - "minimum": 0 - } - } - }, - "VisibilityRuleReq": { - "description": "Model for Visibility Rule Request", - "examples": [ - [ - { - "disabled": { - "commenter": true, - "creator": true, - "editor": true, - "guest": true, - "owner": true, - "viewer": true - } - } - ] - ], - "items": { - "properties": { - "id": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "disabled": { - "properties": { - "commenter": { - "$ref": "#/components/schemas/Bool" - }, - "creator": { - "$ref": "#/components/schemas/Bool" - }, - "editor": { - "$ref": "#/components/schemas/Bool" - }, - "guest": { - "$ref": "#/components/schemas/Bool" - }, - "owner": { - "$ref": "#/components/schemas/Bool" - }, - "viewer": { - "$ref": "#/components/schemas/Bool" - } - }, - "type": "object" - } - }, - "type": "object" - }, - "title": "Visibility Rule Request Model", - "type": "array", - "x-stoplight": { - "id": "vuo5q4vwtarx8" - } - } - }, - "responses": { - "ProjectList": { - "description": "Example response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProjectList" - }, - "examples": { - "example-1": { - "value": { - "list": [ - { - "bases": [ - { - "alias": "string", - "config": null, - "created_at": "2023-03-01 14:27:36", - "enabled": true, - "id": "string", - "inflection_column": "camelize", - "inflection_table": "camelize", - "is_meta": true, - "order": 1, - "project_id": "string", - "type": "mysql2", - "updated_at": "2023-03-01 14:27:36" - } - ], - "color": "#24716E", - "created_at": "2023-03-01 14:27:36", - "deleted": true, - "description": "This is my project description", - "id": "p_124hhlkbeasewh", - "is_meta": true, - "meta": {}, - "order": 0, - "prefix": "nc_vm5q__", - "status": "string", - "title": "my-project", - "updated_at": "2023-03-01 14:27:36" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "BaseList": { - "description": "Example response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BaseList" - }, - "examples": { - "example-1": { - "value": { - "list": [ - { - "id": "ds_krsappzu9f8vmo", - "project_id": "p_01clqvzik3izk6", - "alias": null, - "config": "", - "meta": null, - "is_meta": 1, - "type": "mysql2", - "inflection_column": "camelize", - "inflection_table": "camelize", - "created_at": "2023-03-01 16:31:49", - "updated_at": "2023-03-02 11:28:17", - "enabled": 1, - "order": 1 - }, - { - "id": "ds_btbdt19zde0gj9", - "project_id": "p_01clqvzik3izk6", - "alias": "sakila", - "config": "", - "meta": null, - "is_meta": null, - "type": "mysql2", - "inflection_column": "camelize", - "inflection_table": "camelize", - "created_at": "2023-03-02 11:28:17", - "updated_at": "2023-03-02 11:28:17", - "enabled": 1, - "order": 2 - } - ], - "pageInfo": { - "totalRows": 2, - "page": 1, - "pageSize": 2, - "isFirstPage": true, - "isLastPage": true - } - } - } - } - } - } - }, - "TableList": { - "description": "Example response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TableList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "id": "md_5hua2iqloqirhd", - "base_id": "ds_jxuewivwbxeum2", - "project_id": "p_tbhl1hnycvhe5l", - "table_name": "nc_b84e___Sheet-1", - "title": "Sheet-1", - "type": "table", - "meta": null, - "schema": null, - "enabled": true, - "mm": false, - "tags": null, - "pinned": null, - "deleted": null, - "order": 1, - "created_at": "2023-03-11T09:11:45.907Z", - "updated_at": "2023-03-11T09:11:45.907Z" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "ColumnList": { - "description": "Example response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ColumnList" - } - } - } - }, - "FilterList": { - "description": "Example response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FilterList" - } - } - } - }, - "SortList": { - "description": "Example response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SortList" - }, - "examples": {} - } - } - }, - "ViewList": { - "description": "Example response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ViewList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "alias": "string", - "column": [ - { - "alias": "string", - "auto_increment": true, - "auto_update_timestamp": true, - "base_id": "string", - "character_maximum_length": "string", - "character_set_name": "string", - "colOptions": { - "deleted": "string", - "dr": "string", - "fk_child_column_id": "string", - "fk_column_id": "string", - "fk_index_name": "string", - "fk_mm_child_column_id": "string", - "fk_mm_model_id": "string", - "fk_mm_parent_column_id": "string", - "fk_parent_column_id": "string", - "id": "string", - "order": "string", - "type": "string", - "ur": "string", - "virtual": true - }, - "column_comment": "string", - "column_default": "string", - "column_ordinal_position": "string", - "column_type": "string", - "data_type": "string", - "data_type_x": "string", - "data_type_x_precision": "string", - "data_type_x_scale": "string", - "deleted": true, - "fk_model_id": "string", - "id": "string", - "numeric_precision": "string", - "numeric_scale": "string", - "order": 0, - "primary_key": true, - "primary_value": true, - "rqd": "string", - "title": "string", - "ui_data_type": "string", - "un": "string", - "unique": true, - "visible": true - } - ], - "columnByIds": {}, - "deleted": true, - "enabled": true, - "fk_base_id": "string", - "fk_project_id": "string", - "id": "string", - "order": 0, - "parent_id": "string", - "pinned": true, - "show_as": "string", - "tags": "string", - "title": "string", - "type": "string" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "SharedViewList": { - "description": "Example response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SharedViewList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:46:31", - "fk_model_id": "md_mhs9z4r2ak98x0", - "id": "vw_lg052cnc1c26kf", - "is_default": 1, - "lock_type": "collaborative", - "meta": {}, - "order": 1, - "password": null, - "project_id": "p_xm3thidrblw4n7", - "show": 1, - "show_system_fields": null, - "title": "Sheet-1", - "type": 3, - "updated_at": "2023-03-02 17:46:31", - "uuid": null, - "view": { - "base_id": "ds_g4ccx6e77h1dmi", - "created_at": "2023-03-02 17:46:31", - "fk_view_id": "vw_lg052cnc1c26kf", - "meta": null, - "project_id": "p_xm3thidrblw4n7", - "row_height": null, - "updated_at": "2023-03-02 17:46:31", - "uuid": null - } - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "HookList": { - "description": "Example response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HookList" - } - } - } - }, - "UserList": { - "description": "Example response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UserList" - }, - "examples": { - "Example 1": { - "value": { - "list": [ - { - "email": "user@example.com", - "email_verified": true, - "firstname": "Alice", - "id": "us_8kugj628ebjngs", - "lastname": "Smith", - "roles": "org-level-viewer" - } - ], - "pageInfo": { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - } - } - } - } - } - }, - "APITokenList": { - "description": "Example response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiTokenList" - }, - "examples": {} - } - }, - "type": "object", - "properties": { - "list": { - "type": "array", - "x-stoplight": { - "id": "uukp6v55zfp7i" - }, - "items": { - "$ref": "#/components/schemas/ApiToken", - "x-stoplight": { - "id": "9zqpoqfkdxy0y" - } - } - }, - "pageInfo": { - "$ref": "#/components/schemas/Paginated", - "x-stoplight": { - "id": "6unr17jyisial" - } - } - } - }, - "BadRequest": { - "description": "BadReqeust", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "msg": { - "type": "string", - "x-stoplight": { - "id": "p9mk4oi0hbihm" - }, - "example": "BadRequest [Error]: " - } - }, - "required": ["msg"] - }, - "examples": { - "Example 1": { - "value": { - "msg": "BadRequest [Error]: " - } - } - } - } - }, - "headers": {} - } - }, - "securitySchemes": { - "xc-auth": { - "name": "Auth Token ", - "type": "apiKey", - "in": "header", - "description": "Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable `NC_JWT_EXPIRES_IN`." - }, - "xc-shared-base-id": { - "name": "Shared Base ID", - "type": "apiKey", - "in": "header", - "description": "Shared base uuid" - } - }, - "parameters": { - "xc-auth": { - "name": "xc-auth", - "in": "header", - "required": false, - "schema": { - "type": "string" - }, - "description": "Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN." - } - } - } }