github
/
nocodb
mirror of https://github.com/nocodb/nocodb
1
0
Fork 0
Code Issues Releases Wiki Activity
Browse Source

refactor: add description and sample in swagger.json 

Signed-off-by: Pranav C <pranavxc@gmail.com>
pull/5222/head
Pranav C 2 years ago
parent
bbc7695e69
commit
9fae69de4b
2 changed files with 435 additions and 291 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 259
      packages/nocodb-sdk/src/lib/Api.ts
  2. 467
      packages/nocodb/src/schema/swagger.json

259
packages/nocodb-sdk/src/lib/Api.ts
Unescape View File

@ -800,7 +800,7 @@ export interface FormColumnType {
description?: StringOrNullType;
/** Foreign Key to Column */
fk_column_id?: IdType;
/** Model for ID */
/** Foreign Key to View */
fk_view_id?: IdType;
/** Form Column Help Text */
help?: StringOrNullType;
@ -887,12 +887,16 @@ export interface GalleryType {
cover_image_idx?: number;
/** Model for Bool */
deleted?: BoolType;
/** Foreign Key to Cover Image Column */
fk_cover_image_col_id?: string;
/** Foreign Key to Model */
fk_model_id?: string;
/** Foreign Key to View */
fk_view_id?: string;
lock_type?: 'collaborative' | 'locked' | 'personal';
/** Model for Bool */
next_enabled?: BoolType;
/** Order of Gallery */
order?: number;
/** Model for Bool */
prev_enabled?: BoolType;
@ -1264,14 +1268,17 @@ export interface LicenseReqType {
* Model for LinkToAnotherColumn Request
*/
export interface LinkToAnotherColumnReqType {
/** Model for ID */
/** Foreign Key to chhild column */
childId: IdType;
/** Model for ID */
/** Foreign Key to parent column */
parentId: IdType;
/** The title of the virtual column */
title: string;
/** The type of the relationship */
type: 'bt' | 'hm' | 'mm';
/** Abstract type of the relationship */
uidt: 'LinkToAnotherRecord';
/** Model for Bool */
/** Is this relationship virtual? */
virtual?: BoolType;
}
@ -1439,31 +1446,39 @@ export interface ModelRoleVisibilityType {
* Model for Normal Column Request
*/
export interface NormalColumnRequestType {
/** Model for Bool */
/** Is this column auto-incremented? */
ai?: BoolType;
/** Model for Bool */
/** Is this column auto-updated datetime field? */
au?: BoolType;
/** Model for StringOrNull */
/** Column Comment */
cc?: StringOrNullType;
/** Model for StringOrNull */
/** Column Default Value */
cdf?: StringOrNullType;
/** Column Name */
column_name: string;
/** Model for StringOrNull */
csn?: StringOrNullType;
/** Data Type */
dt?: string;
/** Model for StringOrNull */
/** Data Type Extra */
dtx?: StringOrNullType;
/** Data Type Extra Precision */
dtxp?: StringOrNullType | number;
/** Data Type Extra Scale */
dtxs?: StringOrNullType | number;
/** Numeric Precision */
np?: StringOrNullType | number;
/** Numeric Scale */
ns?: StringOrNullType | number;
/** Model for Bool */
/** Is this column a primary key? */
pk?: BoolType;
/** Model for Bool */
/** Is this column a primary value? */
pv?: BoolType;
/** Model for Bool */
/** Is this column required? */
rqd?: BoolType;
/** Column Title */
title?: string;
/** UI Data Type */
uidt?:
| 'Attachment'
| 'AutoNumber'
@ -1502,9 +1517,9 @@ export interface NormalColumnRequestType {
| 'URL'
| 'Year'
| 'QrCode';
/** Model for Bool */
/** Is this column unique? */
un?: BoolType;
/** Model for Bool */
/** Is this column unique? */
unique?: BoolType;
}
@ -1514,6 +1529,7 @@ export interface NormalColumnRequestType {
export interface OrgUserReqType {
/** @format email */
email?: string;
/** Roles for the project user */
roles?: 'org-level-creator' | 'org-level-viewer';
}
@ -2477,6 +2493,7 @@ export class Api<
}` OK
* @response `400` `{
\** Error Message *\
msg?: string,
}` Bad Request
@ -2488,6 +2505,7 @@ export class Api<
token?: string;
},
{
/** Error Message */
msg?: string;
}
>({
@ -2511,7 +2529,7 @@ export class Api<
me: (
query?: {
/** Pass project id to get project specific roles along with user info */
project_id?: string;
project_id?: IdType;
},
params: RequestParams = {}
) =>
@ -2550,10 +2568,12 @@ export class Api<
* @summary Change Password
* @request POST:/api/v1/auth/password/change
* @response `200` `{
\** Success Message *\
msg?: string,
}` OK
* @response `400` `{
\** Error Message *\
msg?: string,
}` Bad request
@ -2561,9 +2581,11 @@ export class Api<
passwordChange: (data: PasswordChangeReqType, params: RequestParams = {}) =>
this.request<
{
/** Success Message */
msg?: string;
},
{
/** Error Message */
msg?: string;
}
>({
@ -2637,6 +2659,7 @@ export class Api<
* @summary Refresh Token
* @request POST:/api/v1/auth/token/refresh
* @response `200` `{
\** New access token for user *\
token?: string,
}` OK
@ -2644,6 +2667,7 @@ export class Api<
tokenRefresh: (params: RequestParams = {}) =>
this.request<
{
/** New access token for user */
token?: string;
},
any
@ -2860,6 +2884,7 @@ export class Api<
* @summary Get App License
* @request GET:/api/v1/license
* @response `200` `{
\** Application license key *\
key?: string,
}` OK
@ -2867,6 +2892,7 @@ export class Api<
get: (params: RequestParams = {}) =>
this.request<
{
/** Application license key */
key?: string;
},
any
@ -2904,6 +2930,10 @@ export class Api<
* @summary Get App Settings
* @request GET:/api/v1/app-settings
* @response `200` `{
\**
* Status of invite only signup
* @example true
*\
invite_only_signup?: boolean,
}` OK
@ -2911,6 +2941,10 @@ export class Api<
get: (params: RequestParams = {}) =>
this.request<
{
/**
* Status of invite only signup
* @example true
*/
invite_only_signup?: boolean;
},
any
@ -2932,6 +2966,10 @@ export class Api<
*/
set: (
data: {
/**
* Status of invite only signup
* @example true
*/
invite_only_signup?: boolean;
},
params: RequestParams = {}
@ -3060,7 +3098,9 @@ export class Api<
* @summary Generate Organisation User Password Reset Token
* @request POST:/api/v1/users/{userId}/generate-reset-url
* @response `200` `{
\** Password Reset Token for the user *\
reset_password_token?: string,
\** Password Reset URL for the user *\
reset_password_url?: string,
}` OK
@ -3068,7 +3108,9 @@ export class Api<
generatePasswordResetToken: (userId: IdType, params: RequestParams = {}) =>
this.request<
{
/** Password Reset Token for the user */
reset_password_token?: string;
/** Password Reset URL for the user */
reset_password_url?: string;
},
any
@ -3088,13 +3130,45 @@ export class Api<
* @summary Get Project info
* @request GET:/api/v1/db/meta/projects/{projectId}/info
* @response `200` `{
\**
* Node version
* @example v12.16.1
*\
Node?: string,
\**
* Architecture type
* @example x64
*\
Arch?: string,
\**
* Platform type
* @example linux
*\
Platform?: string,
\**
* Is docker
* @example false
*\
Docker?: boolean,
\**
* Database type
* @example postgres
*\
Database?: string,
ProjectOnRootDB?: string,
\**
* Is project on rootdb
* @example false
*\
ProjectOnRootDB?: boolean,
\**
* Root database type
* @example postgres
*\
RootDB?: string,
\**
* Package version
* @example 1.0.0
*\
PackageVersion?: string,
}` OK
@ -3102,13 +3176,45 @@ export class Api<
metaGet: (projectId: IdType, params: RequestParams = {}) =>
this.request<
{
/**
* Node version
* @example v12.16.1
*/
Node?: string;
/**
* Architecture type
* @example x64
*/
Arch?: string;
/**
* Platform type
* @example linux
*/
Platform?: string;
/**
* Is docker
* @example false
*/
Docker?: boolean;
/**
* Database type
* @example postgres
*/
Database?: string;
ProjectOnRootDB?: string;
/**
* Is project on rootdb
* @example false
*/
ProjectOnRootDB?: boolean;
/**
* Root database type
* @example postgres
*/
RootDB?: string;
/**
* Package version
* @example 1.0.0
*/
PackageVersion?: string;
},
any
@ -3175,18 +3281,10 @@ export class Api<
* @request GET:/api/v1/db/meta/projects/
* @response `201` `ProjectListType`
*/
list: (
query?: {
page?: number;
pageSize?: number;
sort?: string;
},
params: RequestParams = {}
) =>
list: (params: RequestParams = {}) =>
this.request<ProjectListType, any>({
path: `/api/v1/db/meta/projects/`,
method: 'GET',
query: query,
...params,
}),
@ -3201,6 +3299,7 @@ export class Api<
*/
create: (
data: ProjectType & {
/** If true, the project will us an external database else it will use the root database */
external?: boolean;
},
params: RequestParams = {}
@ -3273,8 +3372,14 @@ export class Api<
* @summary Get Project Shared Base
* @request GET:/api/v1/db/meta/projects/{projectId}/shared
* @response `200` `{
\**
* @format uuid
* @example a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11
*\
uuid?: string,
\** @format uri *\
url?: string,
\** @example viewer *\
roles?: string,
}` OK
@ -3282,8 +3387,14 @@ export class Api<
sharedBaseGet: (projectId: IdType, params: RequestParams = {}) =>
this.request<
{
/**
* @format uuid
* @example a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11
*/
uuid?: string;
/** @format uri */
url?: string;
/** @example viewer */
roles?: string;
},
any
@ -3355,8 +3466,14 @@ export class Api<
* @summary Update Project Shared Base
* @request PATCH:/api/v1/db/meta/projects/{projectId}/shared
* @response `200` `{
\**
* @format uuid
* @example a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11
*\
uuid?: string,
\** @format uri *\
url?: string,
\** @example viewer *\
roles?: string,
}` OK
@ -3368,8 +3485,14 @@ export class Api<
) =>
this.request<
{
/**
* @format uuid
* @example a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11
*/
uuid?: string;
/** @format uri */
url?: string;
/** @example viewer */
roles?: string;
},
any
@ -3760,8 +3883,20 @@ export class Api<
update: (
tableId: IdType,
data: {
/**
* Table name
* @example users
*/
table_name?: string;
/**
* Table title
* @example Users
*/
title?: string;
/**
* Project ID
* @example p_124hhlkbeasewh
*/
project_id?: string;
/** Model for Meta */
meta?: MetaType;
@ -3937,7 +4072,7 @@ export class Api<
* @request PATCH:/api/v1/db/meta/views/{viewId}
* @response `200` `void` OK
*/
update: (viewId: string, data: ViewReqType, params: RequestParams = {}) =>
update: (viewId: IdType, data: ViewReqType, params: RequestParams = {}) =>
this.request<void, any>({
path: `/api/v1/db/meta/views/${viewId}`,
method: 'PATCH',
@ -3955,7 +4090,7 @@ export class Api<
* @request DELETE:/api/v1/db/meta/views/{viewId}
* @response `200` `void` OK
*/
delete: (viewId: string, params: RequestParams = {}) =>
delete: (viewId: IdType, params: RequestParams = {}) =>
this.request<void, any>({
path: `/api/v1/db/meta/views/${viewId}`,
method: 'DELETE',
@ -3972,7 +4107,7 @@ export class Api<
* @response `200` `void` OK
*/
showAllColumn: (
viewId: string,
viewId: IdType,
query?: {
ignoreIds?: any[];
},
@ -3995,7 +4130,7 @@ export class Api<
* @response `200` `void` OK
*/
hideAllColumn: (
viewId: string,
viewId: IdType,
query?: {
ignoreIds?: any[];
},
@ -4064,7 +4199,7 @@ export class Api<
* @response `200` `void` OK
*/
formUpdate: (
formViewId: string,
formViewId: IdType,
data: FormReqType,
params: RequestParams = {}
) =>
@ -4085,7 +4220,7 @@ export class Api<
* @request GET:/api/v1/db/meta/forms/{formViewId}
* @response `200` `FormType` OK
*/
formRead: (formViewId: string, params: RequestParams = {}) =>
formRead: (formViewId: IdType, params: RequestParams = {}) =>
this.request<FormType, any>({
path: `/api/v1/db/meta/forms/${formViewId}`,
method: 'GET',
@ -4531,6 +4666,10 @@ export class Api<
create: (
viewId: string,
data: SortReqType & {
/**
* Push the sort to the top of the list
* @example true
*/
push_to_top?: boolean;
},
params: RequestParams = {}
@ -4640,7 +4779,7 @@ export class Api<
* @request GET:/api/v1/db/meta/filters/{filterId}
* @response `200` `FilterType` OK
*/
get: (filterId: string, params: RequestParams = {}) =>
get: (filterId: IdType, params: RequestParams = {}) =>
this.request<FilterType, any>({
path: `/api/v1/db/meta/filters/${filterId}`,
method: 'GET',
@ -4658,7 +4797,7 @@ export class Api<
* @response `200` `void` OK
*/
update: (
filterId: string,
filterId: IdType,
data: FilterReqType,
params: RequestParams = {}
) =>
@ -4679,7 +4818,7 @@ export class Api<
* @request DELETE:/api/v1/db/meta/filters/{filterId}
* @response `200` `void` OK
*/
delete: (filterId: string, params: RequestParams = {}) =>
delete: (filterId: IdType, params: RequestParams = {}) =>
this.request<void, any>({
path: `/api/v1/db/meta/filters/${filterId}`,
method: 'DELETE',
@ -4695,7 +4834,7 @@ export class Api<
* @request GET:/api/v1/db/meta/filters/{filterGroupId}/children
* @response `200` `(FilterType)[]` OK
*/
childrenRead: (filterGroupId: string, params: RequestParams = {}) =>
childrenRead: (filterGroupId: IdType, params: RequestParams = {}) =>
this.request<FilterType[], any>({
path: `/api/v1/db/meta/filters/${filterGroupId}/children`,
method: 'GET',
@ -4713,7 +4852,7 @@ export class Api<
* @request GET:/api/v1/db/meta/hooks/{hookId}/filters
* @response `200` `FilterListType`
*/
read: (hookId: string, params: RequestParams = {}) =>
read: (hookId: IdType, params: RequestParams = {}) =>
this.request<FilterListType, any>({
path: `/api/v1/db/meta/hooks/${hookId}/filters`,
method: 'GET',
@ -4729,7 +4868,7 @@ export class Api<
* @request POST:/api/v1/db/meta/hooks/{hookId}/filters
* @response `200` `void` OK
*/
create: (hookId: string, data: FilterReqType, params: RequestParams = {}) =>
create: (hookId: IdType, data: FilterReqType, params: RequestParams = {}) =>
this.request<void, any>({
path: `/api/v1/db/meta/hooks/${hookId}/filters`,
method: 'POST',
@ -6036,6 +6175,7 @@ export class Api<
* @name UrlToConfig
* @summary Convert JDBC URL to Config
* @request POST:/api/v1/url_to_config
* @response `200` `any` OK
*/
urlToConfig: (data: any, params: RequestParams = {}) =>
this.request<any, any>({
@ -6043,6 +6183,7 @@ export class Api<
method: 'POST',
body: data,
type: ContentType.Json,
format: 'json',
...params,
}),
@ -6127,36 +6268,57 @@ export class Api<
projectCount?: number,
projects?: ({
tableCount?: {
\** Table Count *\
table?: number,
\** View Count *\
view?: number,
},
\** External Project *\
external?: boolean,
viewCount?: {
\** Form Count *\
formCount?: number,
\** Grid Count *\
gridCount?: number,
\** Gallery Count *\
galleryCount?: number,
\** Kanban Count *\
kanbanCount?: number,
\** Total View Count *\
total?: number,
\** Shared Form Count *\
sharedFormCount?: number,
\** Shared Grid Count *\
sharedGridCount?: number,
\** Shared Gallery Count *\
sharedGalleryCount?: number,
\** Shared Kanban Count *\
sharedKanbanCount?: number,
\** Shared Total View Count *\
sharedTotal?: number,
\** Shared Locked View Count *\
sharedLockedCount?: number,
},
\** Webhook Count *\
webhookCount?: number,
\** Filter Count *\
filterCount?: number,
\** Sort Count *\
sortCount?: number,
\** Row Count *\
rowCount?: ({
TotalRecords?: string,
})[],
\** Total project user Count *\
userCount?: number,
})[],
\** Total user Count *\
userCount?: number,
\** Total shared base Count *\
sharedBaseCount?: number,
}` OK
@ -6167,32 +6329,53 @@ export class Api<
projectCount?: number;
projects?: {
tableCount?: {
/** Table Count */
table?: number;
/** View Count */
view?: number;
};
/** External Project */
external?: boolean;
viewCount?: {
/** Form Count */
formCount?: number;
/** Grid Count */
gridCount?: number;
/** Gallery Count */
galleryCount?: number;
/** Kanban Count */
kanbanCount?: number;
/** Total View Count */
total?: number;
/** Shared Form Count */
sharedFormCount?: number;
/** Shared Grid Count */
sharedGridCount?: number;
/** Shared Gallery Count */
sharedGalleryCount?: number;
/** Shared Kanban Count */
sharedKanbanCount?: number;
/** Shared Total View Count */
sharedTotal?: number;
/** Shared Locked View Count */
sharedLockedCount?: number;
};
/** Webhook Count */
webhookCount?: number;
/** Filter Count */
filterCount?: number;
/** Sort Count */
sortCount?: number;
/** Row Count */
rowCount?: {
TotalRecords?: string;
}[];
/** Total project user Count */
userCount?: number;
}[];
/** Total user Count */
userCount?: number;
/** Total shared base Count */
sharedBaseCount?: number;
},
any

467
packages/nocodb/src/schema/swagger.json
Unescape View File

@ -151,7 +151,8 @@
"type": "object",
"properties": {
"msg": {
"type": "string"
"type": "string",
"description": "Error Message"
}
}
}
@ -215,7 +216,7 @@
"parameters": [
{
"schema": {
"type": "string"
"$ref": "#/components/schemas/Id"
},
"in": "query",
"name": "project_id",
@ -264,7 +265,8 @@
"type": "object",
"properties": {
"msg": {
"type": "string"
"type": "string",
"description": "Success Message"
}
}
},
@ -286,7 +288,8 @@
"type": "object",
"properties": {
"msg": {
"type": "string"
"type": "string",
"description": "Error Message"
}
}
},
@ -345,7 +348,8 @@
{
"schema": {
"type": "string",
"format": "uuid"
"format": "uuid",
"example": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11"
},
"name": "token",
"in": "path",
@ -370,7 +374,8 @@
{
"schema": {
"type": "string",
"format": "uuid"
"format": "uuid",
"example": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11"
},
"name": "token",
"in": "path",
@ -404,7 +409,8 @@
{
"schema": {
"type": "string",
"format": "uuid"
"format": "uuid",
"example": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11"
},
"name": "token",
"in": "path",
@ -426,7 +432,8 @@
"type": "object",
"properties": {
"token": {
"type": "string"
"type": "string",
"description": "New access token for user"
}
}
}
@ -554,7 +561,8 @@
"type": "object",
"properties": {
"key": {
"type": "string"
"type": "string",
"description": "Application license key"
}
}
}
@ -607,7 +615,9 @@
"type": "object",
"properties": {
"invite_only_signup": {
"type": "boolean"
"type": "boolean",
"description": "Status of invite only signup",
"example": true
}
}
}
@ -634,7 +644,9 @@
"type": "object",
"properties": {
"invite_only_signup": {
"type": "boolean"
"type": "boolean",
"description": "Status of invite only signup",
"example": true
}
}
},
@ -646,8 +658,7 @@
}
}
}
},
"description": ""
}
},
"tags": ["Org App Settings"],
"description": "Update the application settings. Exclusive for super admin."
@ -823,10 +834,12 @@
"type": "object",
"properties": {
"reset_password_token": {
"type": "string"
"type": "string",
"description": "Password Reset Token for the user"
},
"reset_password_url": {
"type": "string"
"type": "string",
"description": "Password Reset URL for the user"
}
}
}
@ -948,28 +961,44 @@
"type": "object",
"properties": {
"Node": {
"type": "string"
"type": "string",
"description": "Node version",
"example": "v12.16.1"
},
"Arch": {
"type": "string"
"type": "string",
"description": "Architecture type",
"example": "x64"
},
"Platform": {
"type": "string"
"type": "string",
"description": "Platform type",
"example": "linux"
},
"Docker": {
"type": "boolean"
"type": "boolean",
"description": "Is docker",
"example": false
},
"Database": {
"type": "string"
"type": "string",
"description": "Database type",
"example": "postgres"
},
"ProjectOnRootDB": {
"type": "string"
"type": "boolean",
"description": "Is project on rootdb",
"example": false
},
"RootDB": {
"type": "string"
"type": "string",
"description": "Root database type",
"example": "postgres"
},
"PackageVersion": {
"type": "string"
"type": "string",
"description": "Package version",
"example": "1.0.0"
}
}
}
@ -1127,27 +1156,6 @@
},
"description": "List all project meta data",
"parameters": [
{
"schema": {
"type": "number"
},
"in": "query",
"name": "page"
},
{
"schema": {
"type": "number"
},
"in": "query",
"name": "pageSize"
},
{
"schema": {
"type": "string"
},
"in": "query",
"name": "sort"
},
{
"schema": {
"type": "string"
@ -1187,7 +1195,8 @@
"properties": {
"external": {
"type": "boolean",
"default": false
"default": false,
"description": "If true, the project will us an external database else it will use the root database"
}
}
}
@ -1528,13 +1537,17 @@
"type": "object",
"properties": {
"uuid": {
"type": "string"
"type": "string",
"format": "uuid",
"example": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11"
},
"url": {
"type": "string"
"type": "string",
"format": "uri"
},
"roles": {
"type": "string"
"type": "string",
"example": "viewer"
}
}
}
@ -1609,13 +1622,17 @@
"type": "object",
"properties": {
"uuid": {
"type": "string"
"type": "string",
"format": "uuid",
"example": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11"
},
"url": {
"type": "string"
"type": "string",
"format": "uri"
},
"roles": {
"type": "string"
"type": "string",
"example": "viewer"
}
}
}
@ -2540,13 +2557,19 @@
"type": "object",
"properties": {
"table_name": {
"type": "string"
"type": "string",
"description": "Table name",
"example": "users"
},
"title": {
"type": "string"
"type": "string",
"description": "Table title",
"example": "Users"
},
"project_id": {
"type": "string"
"type": "string",
"description": "Project ID",
"example": "p_124hhlkbeasewh"
},
"meta": {
"$ref": "#/components/schemas/Meta"
@ -3255,7 +3278,7 @@
"parameters": [
{
"schema": {
"type": "string",
"$ref": "#/components/schemas/Id",
"example": "vw_wtdg2meyig5l4q"
},
"name": "viewId",
@ -3300,7 +3323,7 @@
"parameters": [
{
"schema": {
"type": "string",
"$ref": "#/components/schemas/Id",
"example": "vw_wtdg2meyig5l4q"
},
"name": "viewId",
@ -3334,7 +3357,7 @@
"parameters": [
{
"schema": {
"type": "string",
"$ref": "#/components/schemas/Id",
"example": "vw_wtdg2meyig5l4q"
},
"name": "viewId",
@ -3573,7 +3596,8 @@
"parameters": [
{
"schema": {
"$ref": "#/components/schemas/Id"
"$ref": "#/components/schemas/Id",
"example": "vw_wtdg2meyig5l4q"
},
"name": "viewId",
"in": "path",
@ -3685,7 +3709,9 @@
"type": "object",
"properties": {
"push_to_top": {
"type": "boolean"
"type": "boolean",
"example": true,
"description": "Push the sort to the top of the list"
}
}
}
@ -3847,7 +3873,7 @@
"parameters": [
{
"schema": {
"type": "string",
"$ref": "#/components/schemas/Id",
"example": "hk_0063k4o1frnxbr"
},
"name": "hookId",
@ -3904,7 +3930,7 @@
"parameters": [
{
"schema": {
"type": "string",
"$ref": "#/components/schemas/Id",
"pattern": "fi_pgfuo11uhn2xeo"
},
"name": "filterId",
@ -3967,7 +3993,9 @@
"parameters": [
{
"schema": {
"type": "string"
"$ref": "#/components/schemas/Id",
"example": "fi_pgfuo11uhn2xeo",
"description": "Filter Group ID"
},
"name": "filterGroupId",
"in": "path",
@ -4113,7 +4141,7 @@
"parameters": [
{
"schema": {
"type": "string",
"$ref": "#/components/schemas/Id",
"example": "vw_6fqln9vdytdv8q"
},
"name": "formViewId",
@ -4320,8 +4348,7 @@
{
"schema": {
"$ref": "#/components/schemas/Id",
"example": "md_w9gpnaousnfss1",
"type": "string"
"example": "md_w9gpnaousnfss1"
},
"name": "tableId",
"in": "path",
@ -6128,7 +6155,8 @@
"nc-export-offset": {
"schema": {
"type": "integer"
}
},
"description": "The starting offset of the next set of rows"
}
}
}
@ -6189,7 +6217,8 @@
"nc-export-offset": {
"schema": {
"type": "integer"
}
},
"description": "The starting offset of the next set of rows"
}
}
}
@ -6802,7 +6831,9 @@
"schema": {
"type": "string"
},
"in": "header"
"in": "header",
"name": "xc-password",
"description": "Shared view password"
}
],
"description": "Create a new row for the target shared view"
@ -6969,7 +7000,8 @@
"nc-export-offset": {
"schema": {
"type": "integer"
}
},
"description": "The starting offset of the next set of rows"
}
}
}
@ -7891,6 +7923,16 @@
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {}
}
}
}
},
"description": "Extract XC URL From JDBC and parse to connection config"
}
},
@ -8008,62 +8050,80 @@
"type": "object",
"properties": {
"table": {
"type": "integer"
"type": "integer",
"description": "Table Count"
},
"view": {
"type": "integer"
"type": "integer",
"description": "View Count"
}
}
},
"external": {
"type": "boolean"
"type": "boolean",
"description": "External Project",
"default": false
},
"viewCount": {
"type": "object",
"properties": {
"formCount": {
"type": "integer"
"type": "integer",
"description": "Form Count"
},
"gridCount": {
"type": "integer"
"type": "integer",
"description": "Grid Count"
},
"galleryCount": {
"type": "integer"
"type": "integer",
"description": "Gallery Count"
},
"kanbanCount": {
"type": "integer"
"type": "integer",
"description": "Kanban Count"
},
"total": {
"type": "integer"
"type": "integer",
"description": "Total View Count"
},
"sharedFormCount": {
"type": "integer"
"type": "integer",
"description": "Shared Form Count"
},
"sharedGridCount": {
"type": "integer"
"type": "integer",
"description": "Shared Grid Count"
},
"sharedGalleryCount": {
"type": "integer"
"type": "integer",
"description": "Shared Gallery Count"
},
"sharedKanbanCount": {
"type": "integer"
"type": "integer",
"description": "Shared Kanban Count"
},
"sharedTotal": {
"type": "integer"
"type": "integer",
"description": "Shared Total View Count"
},
"sharedLockedCount": {
"type": "integer"
"type": "integer",
"description": "Shared Locked View Count"
}
}
},
"webhookCount": {
"type": "integer"
"type": "integer",
"description": "Webhook Count"
},
"filterCount": {
"type": "integer"
"type": "integer",
"description": "Filter Count"
},
"sortCount": {
"type": "integer"
"type": "integer",
"description": "Sort Count"
},
"rowCount": {
"type": "array",
@ -8074,19 +8134,23 @@
"type": "string"
}
}
}
},
"description": "Row Count"
},
"userCount": {
"type": "integer"
"type": "integer",
"description": "Total project user Count"
}
}
}
},
"userCount": {
"type": "integer"
"type": "integer",
"description": "Total user Count"
},
"sharedBaseCount": {
"type": "integer"
"type": "integer",
"description": "Total shared base Count"
}
},
"x-examples": {
@ -8168,139 +8232,6 @@
}
}
}
},
"application/xml": {
"schema": {
"type": "object",
"properties": {
"projectCount": {
"type": "integer"
},
"projects": {
"type": "array",
"items": {
"type": "object",
"properties": {
"tableCount": {
"type": "object",
"properties": {
"table": {
"type": "integer"
},
"view": {
"type": "integer"
}
}
},
"viewCount": {
"type": "object",
"properties": {
"formCount": {
"type": "integer"
},
"gridCount": {
"type": "integer"
},
"galleryCount": {
"type": "integer"
},
"kanbanCount": {
"type": "integer"
},
"total": {
"type": "integer"
},
"sharedFormCount": {
"type": "integer"
},
"sharedGridCount": {
"type": "integer"
},
"sharedGalleryCount": {
"type": "integer"
},
"sharedKanbanCount": {
"type": "integer"
},
"sharedTotal": {
"type": "integer"
},
"sharedLockedCount": {
"type": "integer"
}
}
},
"webhookCount": {
"type": "integer"
},
"filterCount": {
"type": "integer"
},
"sortCount": {
"type": "integer"
},
"rowCount": {
"type": "array",
"items": {
"type": "object",
"properties": {
"TotalRecords": {
"type": "string"
}
}
}
},
"userCount": {
"type": "integer"
}
}
}
},
"userCount": {
"type": "integer"
},
"sharedBaseCount": {
"type": "integer"
}
},
"x-examples": {
"Example 1": {
"projectCount": 1,
"projects": [
{
"tableCount": {
"table": 3,
"view": 0
},
"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
}
}
}
}
}
}
@ -10238,7 +10169,8 @@
"description": "Foreign Key to Column"
},
"fk_view_id": {
"$ref": "#/components/schemas/Id"
"$ref": "#/components/schemas/Id",
"description": "Foreign Key to View"
},
"help": {
"$ref": "#/components/schemas/StringOrNull",
@ -10457,13 +10389,16 @@
"$ref": "#/components/schemas/Bool"
},
"fk_cover_image_col_id": {
"type": "string"
"type": "string",
"description": "Foreign Key to Cover Image Column"
},
"fk_model_id": {
"type": "string"
"type": "string",
"description": "Foreign Key to Model"
},
"fk_view_id": {
"type": "string"
"type": "string",
"description": "Foreign Key to View"
},
"lock_type": {
"enum": ["collaborative", "locked", "personal"],
@ -10473,7 +10408,8 @@
"$ref": "#/components/schemas/Bool"
},
"order": {
"type": "number"
"type": "number",
"description": "Order of Gallery"
},
"prev_enabled": {
"$ref": "#/components/schemas/Bool"
@ -11309,26 +11245,32 @@
],
"properties": {
"childId": {
"$ref": "#/components/schemas/Id"
"$ref": "#/components/schemas/Id",
"description": "Foreign Key to chhild column"
},
"parentId": {
"$ref": "#/components/schemas/Id"
"$ref": "#/components/schemas/Id",
"description": "Foreign Key to parent column"
},
"title": {
"maxLength": 255,
"minLength": 1,
"type": "string"
"type": "string",
"description": "The title of the virtual column"
},
"type": {
"enum": ["bt", "hm", "mm"],
"type": "string"
"type": "string",
"description": "The type of the relationship"
},
"uidt": {
"enum": ["LinkToAnotherRecord"],
"type": "string"
"type": "string",
"description": "Abstract type of the relationship"
},
"virtual": {
"$ref": "#/components/schemas/Bool"
"$ref": "#/components/schemas/Bool",
"description": "Is this relationship virtual?"
}
},
"required": ["childId", "parentId", "title", "type", "uidt"],
@ -11689,30 +11631,37 @@
],
"properties": {
"ai": {
"$ref": "#/components/schemas/Bool"
"$ref": "#/components/schemas/Bool",
"description": "Is this column auto-incremented?"
},
"au": {
"$ref": "#/components/schemas/Bool"
"$ref": "#/components/schemas/Bool",
"description": "Is this column auto-updated datetime field?"
},
"cc": {
"$ref": "#/components/schemas/StringOrNull"
"$ref": "#/components/schemas/StringOrNull",
"description": "Column Comment"
},
"cdf": {
"$ref": "#/components/schemas/StringOrNull"
"$ref": "#/components/schemas/StringOrNull",
"description": "Column Default Value"
},
"column_name": {
"maxLength": 255,
"minLength": 1,
"type": "string"
"type": "string",
"description": "Column Name"
},
"csn": {
"$ref": "#/components/schemas/StringOrNull"
},
"dt": {
"type": "string"
"type": "string",
"description": "Data Type"
},
"dtx": {
"$ref": "#/components/schemas/StringOrNull"
"$ref": "#/components/schemas/StringOrNull",
"description": "Data Type Extra"
},
"dtxp": {
"oneOf": [
@ -11722,7 +11671,8 @@
{
"type": "number"
}
]
],
"description": "Data Type Extra Precision"
},
"dtxs": {
"oneOf": [
@ -11732,7 +11682,8 @@
{
"type": "number"
}
]
],
"description": "Data Type Extra Scale"
},
"np": {
"oneOf": [
@ -11742,7 +11693,8 @@
{
"type": "integer"
}
]
],
"description": "Numeric Precision"
},
"ns": {
"oneOf": [
@ -11752,20 +11704,25 @@
{
"type": "integer"
}
]
],
"description": "Numeric Scale"
},
"pk": {
"$ref": "#/components/schemas/Bool"
"$ref": "#/components/schemas/Bool",
"description": "Is this column a primary key?"
},
"pv": {
"$ref": "#/components/schemas/Bool"
"$ref": "#/components/schemas/Bool",
"description": "Is this column a primary value?"
},
"rqd": {
"$ref": "#/components/schemas/Bool"
"$ref": "#/components/schemas/Bool",
"description": "Is this column required?"
},
"title": {
"maxLength": 255,
"type": "string"
"type": "string",
"description": "Column Title"
},
"uidt": {
"enum": [
@ -11807,13 +11764,16 @@
"Year",
"QrCode"
],
"type": "string"
"type": "string",
"description": "UI Data Type"
},
"un": {
"$ref": "#/components/schemas/Bool"
"$ref": "#/components/schemas/Bool",
"description": "Is this column unique?"
},
"unique": {
"$ref": "#/components/schemas/Bool"
"$ref": "#/components/schemas/Bool",
"description": "Is this column unique?"
}
},
"title": "Normal Column Request Model",
@ -11835,7 +11795,8 @@
},
"roles": {
"enum": ["org-level-creator", "org-level-viewer"],
"type": "string"
"type": "string",
"description": "Roles for the project user"
}
},
"title": "Organisation User Request Model",

Write Preview
Loading…
Cancel
Save