From d1ce172a380454762feed0b40677bacae46e1a03 Mon Sep 17 00:00:00 2001 From: Raju Udava <86527202+dstala@users.noreply.github.com> Date: Tue, 17 Sep 2024 12:53:22 +0000 Subject: [PATCH] docs: meta v2 fields description --- packages/nocodb/src/schema/swagger-v2.json | 2064 +++++++++++++++++--- 1 file changed, 1777 insertions(+), 287 deletions(-) diff --git a/packages/nocodb/src/schema/swagger-v2.json b/packages/nocodb/src/schema/swagger-v2.json index 681b17a086..f29245a0ac 100644 --- a/packages/nocodb/src/schema/swagger-v2.json +++ b/packages/nocodb/src/schema/swagger-v2.json @@ -13,12 +13,12 @@ "name": "Meta APIs", "tags": [ "Bases", - "Sources", "Tables", "Views", "Fields", "Filters", - "Sorts" + "Sorts", + "Sources" ] }, { @@ -2897,34 +2897,38 @@ "type": "number" }, "in": "query", - "name": "page" + "name": "page", + "description": "Page number for pagination." }, { "schema": { "type": "number" }, "in": "query", - "name": "pageSize" + "name": "pageSize", + "description": "Number of items per page." }, { "schema": { "type": "string" }, "in": "query", - "name": "sort" + "name": "sort", + "description": "Sort order for the table list." }, { "schema": { "type": "boolean" }, "in": "query", - "name": "includeM2M" + "name": "includeM2M", + "description": "A boolean to specify whether to include many-to-many relationships tables in the API response" } ], "tags": [ "DB Table", "Tables" ], - "description": "List all tables in a given base" + "description": "This endpoint allows you to list all tables within a specified base. The API returns a paginated list of table.\n\n**Pagination**: The response is paginated by default, with the first page being returned initially. The response includes the following additional information in the `pageInfo` JSON block:\n\n- `totalRows`: Indicates the total number of tables available in the specified Base ID.\n- `page`: Specifies the current page number.\n- `pageSize`: Defaults to 25 and defines the number of table items listed on each page.\n- `isFirstPage`: A boolean value that indicates whether the current page is the first page of table records in the dataset.\n- `isLastPage`: A boolean value that indicates whether the current page is the last page of table records in the dataset." }, "post": { "summary": "Create Table", @@ -3314,7 +3318,7 @@ "tags": [ "DB Table", "Tables" ], - "description": "Create a new table in a given base", + "description": "This endpoint allows you to create a new table in the specified base.", "parameters": [ { "$ref": "#/components/parameters/xc-token" @@ -3715,7 +3719,7 @@ "tags": [ "DB Table", "Tables" ], - "description": "Read the table meta data by the given table ID", + "description": "Get the table meta data by the given table ID", "parameters": [ { "$ref": "#/components/parameters/xc-token" @@ -3831,7 +3835,7 @@ "tags": [ "DB Table", "Tables" ], - "description": "Delete the table meta data by the given table ID", + "description": "Delete table by the given table ID.", "parameters": [ { "$ref": "#/components/parameters/xc-token" @@ -13825,7 +13829,7 @@ "type": "string" }, "cdf": { - "$ref": "#/components/schemas/StringOrNullOrBooleanOrNumber", + "$ref": "#/components/schemas/FieldDefaultValue", "description": "Column Default" }, "clen": { @@ -17157,297 +17161,1783 @@ "id": "cxh7walcnpkn0" } }, - "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 + "FieldTypeEnum": { + "description": "Column data type. Defaults to SingleLineText", + "enum": [ + "SingleLineText", + "LongText", + "PhoneNumber", + "Email", + "URL", + "Number", + "Decimal", + "Percent", + "Currency", + "Duration", + "Date", + "Time", + "DateTime", + "Year", + "SingleSelect", + "MultiSelect", + "User", + "Attachment", + "Checkbox", + "Rating", + "Button", + "Formula", + "Barcode", + "QrCode", + "Links", + "LinkToAnotherRecord", + "Lookup", + "Rollup", + "ID", + "CreatedTime", + "LastModifiedTime", + "CreatedBy", + "LastModifiedBy", + "GeoData", + "Geometry", + "JSON", + "SpecificDBType" + ], + "type": "string" + }, + "FieldTypeDefaultValue": { + "description": "Column Default Value. Defaults to NULL", + "type": "string" + }, + "FieldTypeMetaValidation": { + "description": "Enable validation for this column. Defaults to FALSE", + "properties": { + "validation": { + "type": "boolean" } - ], + } + }, + "FieldTypeMetaDecimal": { + "description": "Column decimal precision. Defaults to 0", "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/StringOrNullOrBooleanOrNumber", - "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": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "null" - } - ], - "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", - "CreatedTime", - "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", - "Links", - "User", - "CreatedBy", - "LastModifiedBy" - ], - "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?" + "precision": { + "type": "number" } - }, - "title": "Normal Column Request Model", - "type": "object", - "required": [ - "column_name" - ], - "x-stoplight": { - "id": "fn3gqmojvswv2" } }, - "OrgUserReq": { - "description": "Model for Organisation User Update Request", - "examples": [ - { - "email": "user@example.com", - "roles": "org-level-creator" + "FieldTypeMetaLongText": { + "description": "Enable rich text for this column. Defaults to FALSE", + "properties": { + "richText": { + "type": "boolean" } - ], + } + }, + "FieldTypeMetaPercent": { + "description": "Enable percent progress display for this column. Defaults to FALSE", "properties": { - "email": { - "format": "email", + "is_progress": { + "type": "boolean" + } + } + }, + "FieldTypeMetaCurrency": { + "description": "Currency settings for this column. Locale defaults to `en-US` and currency code defaults to `USD`", + "properties": { + "currency_locale": { "type": "string" }, - "roles": { - "enum": [ - "org-level-creator", - "org-level-viewer" - ], - "type": "string", - "description": "Roles for the base user" + "currency_code": { + "type": "string" } - }, - "title": "Organisation User Request Model", - "type": "object", - "x-stoplight": { - "id": "n484boi6jv3up" } }, - "Paginated": { - "description": "Model for Paginated", - "examples": [ - { - "isFirstPage": true, - "isLastPage": true, - "page": 1, - "pageSize": 10, - "totalRows": 1 - } - ], + "FieldTypeMetaDuration": { + "description": "Duration display settings for this column. Options available are \n 1. `h:mm` - Hours and Minutes\n 2. `h:mm:ss` - Hours, Minutes and Seconds\n 3. `h:mm:ss.s` - Hours, Minutes, Seconds and Tenth of a Second\n 4. `h:mm:ss.ss` - Hours, Minutes, Seconds and Hundredth of a Second\n 5. `h:mm:ss.sss` - Hours, Minutes, Seconds and Thousandth of a Second\n\n\nDefaults to `h:mm`", "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, + "duration": { "type": "number" } - }, - "title": "Paginated Model", - "type": "object", - "x-stoplight": { - "id": "2x65v3n9xo8q3" } }, - "Password": { - "description": "Model for Password", - "example": "password123456789", - "examples": [ - "password123456789" - ], - "minLength": 8, - "title": "Password Model", - "type": "string", - "x-stoplight": { - "id": "s7gk265anpyc7" + "FieldTypeMetaDate": { + "description": "Date display format for this column. Defaults to `YYYY-MM-DD`", + "properties": { + "date_format": { + "description": "Options available are\n 1. `YYYY-MM-DD` - Year, Month and Day\n 2. `YYYY/MM/DD` - Year, Month and Day\n 3. `DD-MM-YYYY` - Day, Month and Year\n 4. `MM-DD-YYYY` - Month, Day and Year\n 5. `DD/MM/YYYY` - Day, Month and Year\n 6. `MM/DD/YYYY` - Month, Day and Year\n 7. `DD MM YYYY` - Day, Month and Year\n 8. `MM DD YYYY` - Month, Day and Year\n 9. `YYYY MM DD` - Year, Month and Day\n10. `YYYY MM` - Year and Month\n\n\nDefaults to `YYYY-MM-DD`", + "type": "string" + } } }, - "PasswordChangeReq": { - "description": "Model for Password Change Request", - "examples": [ - { - "currentPassword": "currentpassword", - "newPassword": "newpassword" + "FieldTypeMetaTime": { + "description": "Time display format for this column. Defaults to `24 hour`", + "properties": { + "is12hrFormat": { + "description": "Options available are \n 1. `12 hour` - 12 Hour Format\n 2. `24 hour` - 24 Hour Format\n\n\nDefaults to `24 hour`", + "type": "boolean" } - ], + } + }, + "FieldTypeMetaDateTime": { + "description": "Date Time display format for this column. Defaults to `YYYY-MM-DD h:mm 24h format`", "properties": { - "currentPassword": { + "date_format": { + "description": "Options available are \n 1. `YYYY-MM-DD` - Year, Month and Day\n 2. `YYYY/MM/DD` - Year, Month and Day\n 3. `DD-MM-YYYY` - Day, Month and Year\n 4. `MM-DD-YYYY` - Month, Day and Year\n 5. `DD/MM/YYYY` - Day, Month and Year\n 6. `MM/DD/YYYY` - Month, Day and Year\n 7. `DD MM YYYY` - Day, Month and Year\n 8. `MM DD YYYY` - Month, Day and Year\n 9. `YYYY MM DD` - Year, Month and Day\n\n\nDefaults to `YYYY-MM-DD.", "type": "string" }, - "newPassword": { - "minLength": 8, + "time_format": { + "description": "Options available are \n 1. `h:mm` - Hours and Minutes\n 2. `h:mm:ss` - Hours, Minutes and Seconds\n 3. `h:mm:ss.SSS` - Hours, Minutes, Seconds and Thousandth of a Second\n\n\nDefaults to `h:mm`", "type": "string" + }, + "is12hrFormat": { + "description": "Options available are \n 1. `12 hour` - 12 Hour Format\n 2. `24 hour` - 24 Hour Format\n\n\nDefaults to `24 hour`", + "type": "boolean" } - }, - "required": [ - "currentPassword", - "newPassword" + } + }, + "FieldTypeMetaSelectOption": { + "type": "object", + "properties": { + "title": { + "description": "Title of the option. This is the data that will be displayed in the cell tile", + "type": "string" + }, + "color": { + "description": "Color of the option tile. Hexadecimal color code format. Example: `#FF0000`", + "type": "string" + } + }, + "required": [ + "title" + ] + }, + "FieldTypeMetaSelectOptionsArray": { + "type": "array", + "description": "Array of select options for this column", + "items": { + "$ref": "#/components/schemas/FieldTypeMetaSelectOption" + } + }, + "FieldTypeMetaSelect": { + "description": "Select options for this column", + "properties": { + "options": { + "$ref": "#/components/schemas/FieldTypeMetaSelectOptionsArray" + } + }, + "type": "object" + }, + "FieldTypeMetaUser": { + "description": "User settings to allow for multiple users in this column. Defaults to FALSE", + "properties": { + "is_multi": { + "type": "boolean" + } + } + }, + "FieldTypeMetaCheckbox": { + "description": "Checkbox settings for this column.", + "properties": { + "color": { + "description": "Color of the checkbox icon. Hexadecimal color code format. Example: `#FF0000`", + "type": "string" + }, + "iconIdx": { + "description": "Icon index for the checkbox. Defaults to 0. Options available are \n 1. `Square`\n 2. `Check`\n 3. `Star`\n 4. `Heart`\n 5. `Circle`\n 6. `Thumbs up`\n 7. `Flag`\n\n\nDefaults to 1 : `Square`", + "type": "number" + } + } + }, + "FieldTypeMetaRating": { + "description": "Rating settings for this column", + "properties": { + "color": { + "description": "Color of the rating icon. Hexadecimal color code format. Example: `#FF0000`", + "type": "string" + }, + "iconIdx": { + "description": "Icon index for the rating icon. Defaults to 0. Options available are \n 1. `Square`\n 2. `Check`\n 3. `Star`\n 4. `Heart`\n 5. `Circle`\n 6. `Thumbs up`\n 7. `Flag`\n\n\nDefaults to 1 : `Square`", + "type": "number" + }, + "max": { + "description": "Maximum value for the rating. Defaults to 5. Allowed range 1-10", + "type": "number" + } + } + }, + "FieldTypeMetaButton": { + "description": "Button settings for this column", + "oneOf": [ + { + "$ref": "#/components/schemas/FieldTypeMetaButtonURL" + }, + { + "$ref": "#/components/schemas/FieldTypeMetaButtonWebhook" + } + ], + "discriminator": { + "propertyName": "type", + "mapping": { + "Open URL": "#/components/schemas/FieldTypeMetaButtonURL", + "Run Webhook": "#/components/schemas/FieldTypeMetaButtonWebhook" + } + } + }, + "FieldTypeMetaButtonURL": { + "title": "Open URL", + "type": "object", + "description": "Button URL settings for this column", + "properties": { + "type": { + "description": "Button type: Open URL", + "type": "string", + "enum": [ + "url" + ] + }, + "formula": { + "description": "Formula to generate the URL", + "type": "string" + }, + "icon": { + "description": "Icon of the button", + "type": "string" + }, + "label": { + "description": "Label of the button", + "type": "string" + }, + "color": { + "description": "Color of the button.", + "type": "string", + "enum": [ + "brand", "red", "green", "maroon", "blue", "orange", "pink", "purple", "yellow", "gray" + ] + }, + "theme": { + "description": "Theme of the button", + "type": "string", + "enum": [ + "solid", "light", "text" + ] + } + }, + "required": [ + "type", + "formula" + ] + }, + "FieldTypeMetaButtonAction": { + "title": "AI Action", + "description": "Button Action settings for this column", + "properties": { + "type": { + "description": "Button type: AI Action", + "type": "string", + "enum": [ + "action" + ] + }, + "icon": { + "description": "Icon of the button", + "type": "string" + }, + "label": { + "description": "Label of the button", + "type": "string" + }, + "color": { + "description": "Color of the button.", + "type": "string", + "enum": [ + "brand", "red", "green", "maroon", "blue", "orange", "pink", "purple", "yellow", "gray" + ] + }, + "theme": { + "description": "Theme of the button", + "type": "string", + "enum": [ + "solid", "light", "text" + ] + } + } + }, + "FieldTypeMetaButtonWebhook": { + "title": "Run Webhook", + "description": "Button Webhook settings for this column", + "properties": { + "type": { + "description": "Button type: Run Webhook", + "type": "string", + "enum": [ + "webhook" + ] + }, + "fk_webhook_id": { + "description": "Foreign Key to Webhook (of type `Manual Trigger`)", + "type": "string" + }, + "icon": { + "description": "Icon of the button", + "type": "string" + }, + "label": { + "description": "Label of the button", + "type": "string" + }, + "color": { + "description": "Color of the button.", + "type": "string", + "enum": [ + "brand", "red", "green", "maroon", "blue", "orange", "pink", "purple", "yellow", "gray" + ] + }, + "theme": { + "description": "Theme of the button", + "type": "string", + "enum": [ + "solid", "light", "text" + ] + } + }, + "required": [ + "type", + "fk_webhook_id" + ] + }, + "FieldTypeMetaBarcode": { + "description": "Barcode settings for this column", + "properties": { + "barcode_format": { + "type": "string" + }, + "fk_barcode_value_column_id": { + "description": "Barcode value column ID", + "type": "string" + } + } + }, + "FieldTypeMetaQrCode": { + "description": "QR Code settings for this column", + "properties": { + "fk_qr_value_column_id": { + "description": "QR code value column ID", + "type": "string" + } + } + }, + "FieldTypeMetaLinks": { + "description": "Links settings for this column", + "properties": { + "type": { + "description": "Column type: Links", + "type": "string", + "enum": [ + "hm", + "mm" + ] + }, + "fk_child_column_id": { + "description": "Foreign Key to child column", + "type": "string" + }, + "fk_parent_column_id": { + "description": "Foreign Key to parent column", + "type": "string" + } + } + }, + "FieldTypeMetaLookup": { + "description": "Lookup settings for this column", + "properties": { + "fk_relation_column_id": { + "description": "Foreign Key to relation column", + "type": "string" + }, + "fk_lookup_column_id": { + "description": "Foreign Key to lookup column", + "type": "string" + } + } + }, + "FieldTypeMetaRollup": { + "description": "Rollup settings for this column", + "properties": { + "fk_relation_column_id": { + "description": "Foreign Key to relation column", + "type": "string" + }, + "fk_rollup_column_id": { + "description": "Foreign Key to rollup column", + "type": "string" + }, + "rollup_function": { + "description": "Foreign Key to rollup function", + "type": "string" + } + } + }, + "FieldTypeDescription": { + "description": "Column description. Defaults to NULL", + "type": "string" + }, + "FieldTypeRequired": { + "description": "Set this column as required. Defaults to FALSE", + "type": "boolean" + }, + "FieldTypePrimaryValue": { + "description": "Set this column as primary value. Defaults to FALSE", + "type": "boolean" + }, + "NormalColumnRequest": { + "oneOf": [ + { + "$ref": "#/components/schemas/FieldTypeSingleLineText" + }, + { + "$ref": "#/components/schemas/FieldTypeLongText" + }, + { + "$ref": "#/components/schemas/FieldTypePhoneNumber" + }, + { + "$ref": "#/components/schemas/FieldTypeEmail" + }, + { + "$ref": "#/components/schemas/FieldTypeURL" + }, + { + "$ref": "#/components/schemas/FieldTypeNumber" + }, + { + "$ref": "#/components/schemas/FieldTypeDecimal" + }, + { + "$ref": "#/components/schemas/FieldTypePercent" + }, + { + "$ref": "#/components/schemas/FieldTypeCurrency" + }, + { + "$ref": "#/components/schemas/FieldTypeDuration" + }, + { + "$ref": "#/components/schemas/FieldTypeDate" + }, + { + "$ref": "#/components/schemas/FieldTypeTime" + }, + { + "$ref": "#/components/schemas/FieldTypeDateTime" + }, + { + "$ref": "#/components/schemas/FieldTypeYear" + }, + { + "$ref": "#/components/schemas/FieldTypeSingleSelect" + }, + { + "$ref": "#/components/schemas/FieldTypeMultiSelect" + }, + { + "$ref": "#/components/schemas/FieldTypeUser" + }, + { + "$ref": "#/components/schemas/FieldTypeAttachment" + }, + { + "$ref": "#/components/schemas/FieldTypeCheckbox" + }, + { + "$ref": "#/components/schemas/FieldTypeRating" + }, + { + "$ref": "#/components/schemas/FieldTypeButton" + }, + { + "$ref": "#/components/schemas/FieldTypeFormula" + }, + { + "$ref": "#/components/schemas/FieldTypeBarcode" + }, + { + "$ref": "#/components/schemas/FieldTypeQrCode" + }, + { + "$ref": "#/components/schemas/FieldTypeLinks" + }, + { + "$ref": "#/components/schemas/FieldTypeLinkToAnotherRecord" + }, + { + "$ref": "#/components/schemas/FieldTypeLookup" + }, + { + "$ref": "#/components/schemas/FieldTypeRollup" + }, + { + "$ref": "#/components/schemas/FieldTypeID" + }, + { + "$ref": "#/components/schemas/FieldTypeCreatedTime" + }, + { + "$ref": "#/components/schemas/FieldTypeLastModifiedTime" + }, + { + "$ref": "#/components/schemas/FieldTypeCreatedBy" + }, + { + "$ref": "#/components/schemas/FieldTypeLastModifiedBy" + }, + { + "$ref": "#/components/schemas/FieldTypeGeoData" + }, + { + "$ref": "#/components/schemas/FieldTypeGeometry" + }, + { + "$ref": "#/components/schemas/FieldTypeJSON" + }, + { + "$ref": "#/components/schemas/FieldTypeSpecificDBType" + } + ], + "discriminator": { + "propertyName": "uidt", + "mapping": { + "SingleLineText": "#/components/schemas/FieldTypeSingleLineText", + "LongText": "#/components/schemas/FieldTypeLongText", + "PhoneNumber": "#/components/schemas/FieldTypePhoneNumber", + "Email": "#/components/schemas/FieldTypeEmail", + "URL": "#/components/schemas/FieldTypeURL", + "Number": "#/components/schemas/FieldTypeNumber", + "Decimal": "#/components/schemas/FieldTypeDecimal", + "Percent": "#/components/schemas/FieldTypePercent", + "Currency": "#/components/schemas/FieldTypeCurrency", + "Duration": "#/components/schemas/FieldTypeDuration", + "Date": "#/components/schemas/FieldTypeDate", + "Time": "#/components/schemas/FieldTypeTime", + "DateTime": "#/components/schemas/FieldTypeDateTime", + "Year": "#/components/schemas/FieldTypeYear", + "SingleSelect": "#/components/schemas/FieldTypeSingleSelect", + "MultiSelect": "#/components/schemas/FieldTypeMultiSelect", + "User": "#/components/schemas/FieldTypeUser", + "Attachment": "#/components/schemas/FieldTypeAttachment", + "Checkbox": "#/components/schemas/FieldTypeCheckbox", + "Rating": "#/components/schemas/FieldTypeRating", + "Button": "#/components/schemas/FieldTypeButton", + "Formula": "#/components/schemas/FieldTypeFormula", + "Barcode": "#/components/schemas/FieldTypeBarcode", + "QrCode": "#/components/schemas/FieldTypeQrCode", + "Links": "#/components/schemas/FieldTypeLinks", + "LinkToAnotherRecord": "#/components/schemas/FieldTypeLinkToAnotherRecord", + "Lookup": "#/components/schemas/FieldTypeLookup", + "Rollup": "#/components/schemas/FieldTypeRollup", + "ID": "#/components/schemas/FieldTypeID", + "CreatedTime": "#/components/schemas/FieldTypeCreatedTime", + "LastModifiedTime": "#/components/schemas/FieldTypeLastModifiedTime", + "CreatedBy": "#/components/schemas/FieldTypeCreatedBy", + "LastModifiedBy": "#/components/schemas/FieldTypeLastModifiedBy", + "GeoData": "#/components/schemas/FieldTypeGeoData", + "Geometry": "#/components/schemas/FieldTypeGeometry", + "JSON": "#/components/schemas/FieldTypeJSON", + "SpecificDBType": "#/components/schemas/FieldTypeSpecificDBType" + } + }, + "type": "object" + }, + "FieldTypeSingleLineText": { + "type": "object", + "properties": { + "title": { + "maxLength": 255, + "type": "string", + "minLength": 1, + "description": "Column Title" + }, + "uidt": { + "$ref": "#/components/schemas/FieldTypeEnum" + }, + "description": { + "$ref": "#/components/schemas/FieldTypeDescription" + }, + "cdf": { + "$ref": "#/components/schemas/FieldTypeDefaultValue" + }, + "pv": { + "$ref": "#/components/schemas/FieldTypePrimaryValue" + }, + "rqd": { + "$ref": "#/components/schemas/FieldTypeRequired" + } + }, + "required": [ + "title" + ] + }, + "FieldTypeLongText": { + "type": "object", + "properties": { + "title": { + "maxLength": 255, + "type": "string", + "minLength": 1, + "description": "Column Title" + }, + "uidt": { + "$ref": "#/components/schemas/FieldTypeEnum" + }, + "description": { + "$ref": "#/components/schemas/FieldTypeDescription" + }, + "cdf": { + "$ref": "#/components/schemas/FieldTypeDefaultValue" + }, + "pv": { + "$ref": "#/components/schemas/FieldTypePrimaryValue" + }, + "rqd": { + "$ref": "#/components/schemas/FieldTypeRequired" + }, + "meta": { + "$ref": "#/components/schemas/FieldTypeMetaLongText" + } + }, + "required": [ + "title" + ] + }, + "FieldTypePhoneNumber": { + "type": "object", + "properties": { + "title": { + "maxLength": 255, + "type": "string", + "minLength": 1, + "description": "Column Title" + }, + "uidt": { + "$ref": "#/components/schemas/FieldTypeEnum" + }, + "description": { + "$ref": "#/components/schemas/FieldTypeDescription" + }, + "cdf": { + "$ref": "#/components/schemas/FieldTypeDefaultValue" + }, + "pv": { + "$ref": "#/components/schemas/FieldTypePrimaryValue" + }, + "rqd": { + "$ref": "#/components/schemas/FieldTypeRequired" + }, + "meta": { + "$ref": "#/components/schemas/FieldTypeMetaValidation" + } + }, + "required": [ + "title" + ] + }, + "FieldTypeEmail": { + "type": "object", + "properties": { + "title": { + "maxLength": 255, + "type": "string", + "minLength": 1, + "description": "Column Title" + }, + "uidt": { + "$ref": "#/components/schemas/FieldTypeEnum" + }, + "description": { + "$ref": "#/components/schemas/FieldTypeDescription" + }, + "cdf": { + "$ref": "#/components/schemas/FieldTypeDefaultValue" + }, + "pv": { + "$ref": "#/components/schemas/FieldTypePrimaryValue" + }, + "rqd": { + "$ref": "#/components/schemas/FieldTypeRequired" + }, + "meta": { + "$ref": "#/components/schemas/FieldTypeMetaValidation" + } + }, + "required": [ + "title" + ] + }, + "FieldTypeURL": { + "type": "object", + "properties": { + "title": { + "maxLength": 255, + "type": "string", + "minLength": 1, + "description": "Column Title" + }, + "uidt": { + "$ref": "#/components/schemas/FieldTypeEnum" + }, + "description": { + "$ref": "#/components/schemas/FieldTypeDescription" + }, + "cdf": { + "$ref": "#/components/schemas/FieldTypeDefaultValue" + }, + "pv": { + "$ref": "#/components/schemas/FieldTypePrimaryValue" + }, + "rqd": { + "$ref": "#/components/schemas/FieldTypeRequired" + }, + "meta": { + "$ref": "#/components/schemas/FieldTypeMetaValidation" + } + }, + "required": [ + "title" + ] + }, + "FieldTypeNumber": { + "type": "object", + "properties": { + "title": { + "maxLength": 255, + "type": "string", + "minLength": 1, + "description": "Column Title" + }, + "uidt": { + "$ref": "#/components/schemas/FieldTypeEnum" + }, + "description": { + "$ref": "#/components/schemas/FieldTypeDescription" + }, + "cdf": { + "$ref": "#/components/schemas/FieldTypeDefaultValue" + }, + "pv": { + "$ref": "#/components/schemas/FieldTypePrimaryValue" + }, + "rqd": { + "$ref": "#/components/schemas/FieldTypeRequired" + } + }, + "required": [ + "title" + ] + }, + "FieldTypeDecimal": { + "type": "object", + "properties": { + "title": { + "maxLength": 255, + "type": "string", + "minLength": 1, + "description": "Column Title" + }, + "uidt": { + "$ref": "#/components/schemas/FieldTypeEnum" + }, + "description": { + "$ref": "#/components/schemas/FieldTypeDescription" + }, + "cdf": { + "$ref": "#/components/schemas/FieldTypeDefaultValue" + }, + "pv": { + "$ref": "#/components/schemas/FieldTypePrimaryValue" + }, + "rqd": { + "$ref": "#/components/schemas/FieldTypeRequired" + }, + "meta": { + "$ref": "#/components/schemas/FieldTypeMetaDecimal" + } + }, + "required": [ + "title" + ] + }, + "FieldTypePercent": { + "type": "object", + "properties": { + "title": { + "maxLength": 255, + "type": "string", + "minLength": 1, + "description": "Column Title" + }, + "uidt": { + "$ref": "#/components/schemas/FieldTypeEnum" + }, + "description": { + "$ref": "#/components/schemas/FieldTypeDescription" + }, + "cdf": { + "$ref": "#/components/schemas/FieldTypeDefaultValue" + }, + "pv": { + "$ref": "#/components/schemas/FieldTypePrimaryValue" + }, + "rqd": { + "$ref": "#/components/schemas/FieldTypeRequired" + }, + "meta": { + "$ref": "#/components/schemas/FieldTypeMetaPercent" + } + }, + "required": [ + "title" + ] + }, + "FieldTypeCurrency": { + "type": "object", + "properties": { + "title": { + "maxLength": 255, + "type": "string", + "minLength": 1, + "description": "Column Title" + }, + "uidt": { + "$ref": "#/components/schemas/FieldTypeEnum" + }, + "description": { + "$ref": "#/components/schemas/FieldTypeDescription" + }, + "cdf": { + "$ref": "#/components/schemas/FieldTypeDefaultValue" + }, + "pv": { + "$ref": "#/components/schemas/FieldTypePrimaryValue" + }, + "rqd": { + "$ref": "#/components/schemas/FieldTypeRequired" + }, + "meta": { + "$ref": "#/components/schemas/FieldTypeMetaCurrency" + } + }, + "required": [ + "title" + ] + }, + "FieldTypeDuration": { + "type": "object", + "properties": { + "title": { + "maxLength": 255, + "type": "string", + "minLength": 1, + "description": "Column Title" + }, + "uidt": { + "$ref": "#/components/schemas/FieldTypeEnum" + }, + "description": { + "$ref": "#/components/schemas/FieldTypeDescription" + }, + "cdf": { + "$ref": "#/components/schemas/FieldTypeDefaultValue" + }, + "pv": { + "$ref": "#/components/schemas/FieldTypePrimaryValue" + }, + "rqd": { + "$ref": "#/components/schemas/FieldTypeRequired" + }, + "meta": { + "$ref": "#/components/schemas/FieldTypeMetaDuration" + } + }, + "required": [ + "title" + ] + }, + "FieldTypeDate": { + "type": "object", + "properties": { + "title": { + "maxLength": 255, + "type": "string", + "minLength": 1, + "description": "Column Title" + }, + "uidt": { + "$ref": "#/components/schemas/FieldTypeEnum" + }, + "description": { + "$ref": "#/components/schemas/FieldTypeDescription" + }, + "cdf": { + "$ref": "#/components/schemas/FieldTypeDefaultValue" + }, + "pv": { + "$ref": "#/components/schemas/FieldTypePrimaryValue" + }, + "rqd": { + "$ref": "#/components/schemas/FieldTypeRequired" + }, + "meta": { + "$ref": "#/components/schemas/FieldTypeMetaDate" + } + }, + "required": [ + "title" + ] + }, + "FieldTypeTime": { + "type": "object", + "properties": { + "title": { + "maxLength": 255, + "type": "string", + "minLength": 1, + "description": "Column Title" + }, + "uidt": { + "$ref": "#/components/schemas/FieldTypeEnum" + }, + "description": { + "$ref": "#/components/schemas/FieldTypeDescription" + }, + "cdf": { + "$ref": "#/components/schemas/FieldTypeDefaultValue" + }, + "pv": { + "$ref": "#/components/schemas/FieldTypePrimaryValue" + }, + "rqd": { + "$ref": "#/components/schemas/FieldTypeRequired" + }, + "meta": { + "$ref": "#/components/schemas/FieldTypeMetaTime" + } + }, + "required": [ + "title" + ] + }, + "FieldTypeDateTime": { + "type": "object", + "properties": { + "title": { + "maxLength": 255, + "type": "string", + "minLength": 1, + "description": "Column Title" + }, + "uidt": { + "$ref": "#/components/schemas/FieldTypeEnum" + }, + "description": { + "$ref": "#/components/schemas/FieldTypeDescription" + }, + "cdf": { + "$ref": "#/components/schemas/FieldTypeDefaultValue" + }, + "pv": { + "$ref": "#/components/schemas/FieldTypePrimaryValue" + }, + "rqd": { + "$ref": "#/components/schemas/FieldTypeRequired" + }, + "meta": { + "$ref": "#/components/schemas/FieldTypeMetaDateTime" + } + }, + "required": [ + "title" + ] + }, + "FieldTypeYear": { + "type": "object", + "properties": { + "title": { + "maxLength": 255, + "type": "string", + "minLength": 1, + "description": "Column Title" + }, + "uidt": { + "$ref": "#/components/schemas/FieldTypeEnum" + }, + "description": { + "$ref": "#/components/schemas/FieldTypeDescription" + }, + "cdf": { + "$ref": "#/components/schemas/FieldTypeDefaultValue" + }, + "pv": { + "$ref": "#/components/schemas/FieldTypePrimaryValue" + }, + "rqd": { + "$ref": "#/components/schemas/FieldTypeRequired" + } + }, + "required": [ + "title" + ] + }, + "FieldTypeSingleSelect": { + "type": "object", + "properties": { + "title": { + "maxLength": 255, + "type": "string", + "minLength": 1, + "description": "Column Title" + }, + "uidt": { + "$ref": "#/components/schemas/FieldTypeEnum" + }, + "description": { + "$ref": "#/components/schemas/FieldTypeDescription" + }, + "cdf": { + "$ref": "#/components/schemas/FieldTypeDefaultValue" + }, + "pv": { + "$ref": "#/components/schemas/FieldTypePrimaryValue" + }, + "rqd": { + "$ref": "#/components/schemas/FieldTypeRequired" + }, + "colOptions": { + "$ref": "#/components/schemas/FieldTypeMetaSelect" + } + }, + "required": [ + "title" + ] + }, + "FieldTypeMultiSelect": { + "type": "object", + "properties": { + "title": { + "maxLength": 255, + "type": "string", + "minLength": 1, + "description": "Column Title" + }, + "uidt": { + "$ref": "#/components/schemas/FieldTypeEnum" + }, + "description": { + "$ref": "#/components/schemas/FieldTypeDescription" + }, + "cdf": { + "$ref": "#/components/schemas/FieldTypeDefaultValue" + }, + "pv": { + "$ref": "#/components/schemas/FieldTypePrimaryValue" + }, + "rqd": { + "$ref": "#/components/schemas/FieldTypeRequired" + }, + "colOptions": { + "$ref": "#/components/schemas/FieldTypeMetaSelect" + } + }, + "required": [ + "title" + ] + }, + "FieldTypeUser": { + "type": "object", + "properties": { + "title": { + "maxLength": 255, + "type": "string", + "minLength": 1, + "description": "Column Title" + }, + "uidt": { + "$ref": "#/components/schemas/FieldTypeEnum" + }, + "description": { + "$ref": "#/components/schemas/FieldTypeDescription" + }, + "cdf": { + "$ref": "#/components/schemas/FieldTypeDefaultValue" + }, + "pv": { + "$ref": "#/components/schemas/FieldTypePrimaryValue" + }, + "rqd": { + "$ref": "#/components/schemas/FieldTypeRequired" + }, + "meta": { + "$ref": "#/components/schemas/FieldTypeMetaUser" + } + }, + "required": [ + "title" + ] + }, + "FieldTypeAttachment": { + "type": "object", + "properties": { + "title": { + "maxLength": 255, + "type": "string", + "minLength": 1, + "description": "Column Title" + }, + "uidt": { + "$ref": "#/components/schemas/FieldTypeEnum" + }, + "description": { + "$ref": "#/components/schemas/FieldTypeDescription" + }, + "pv": { + "$ref": "#/components/schemas/FieldTypePrimaryValue" + }, + "rqd": { + "$ref": "#/components/schemas/FieldTypeRequired" + } + }, + "required": [ + "title" + ] + }, + "FieldTypeCheckbox": { + "type": "object", + "properties": { + "title": { + "maxLength": 255, + "type": "string", + "minLength": 1, + "description": "Column Title" + }, + "uidt": { + "$ref": "#/components/schemas/FieldTypeEnum" + }, + "description": { + "$ref": "#/components/schemas/FieldTypeDescription" + }, + "cdf": { + "$ref": "#/components/schemas/FieldTypeDefaultValue" + }, + "pv": { + "$ref": "#/components/schemas/FieldTypePrimaryValue" + }, + "rqd": { + "$ref": "#/components/schemas/FieldTypeRequired" + }, + "meta": { + "$ref": "#/components/schemas/FieldTypeMetaCheckbox" + } + }, + "required": [ + "title" + ] + }, + "FieldTypeRating": { + "type": "object", + "properties": { + "title": { + "maxLength": 255, + "type": "string", + "minLength": 1, + "description": "Column Title" + }, + "uidt": { + "$ref": "#/components/schemas/FieldTypeEnum" + }, + "description": { + "$ref": "#/components/schemas/FieldTypeDescription" + }, + "cdf": { + "$ref": "#/components/schemas/FieldTypeDefaultValue" + }, + "pv": { + "$ref": "#/components/schemas/FieldTypePrimaryValue" + }, + "rqd": { + "$ref": "#/components/schemas/FieldTypeRequired" + }, + "meta": { + "$ref": "#/components/schemas/FieldTypeMetaRating" + } + }, + "required": [ + "title" + ] + }, + "FieldTypeButton": { + "type": "object", + "properties": { + "title": { + "maxLength": 255, + "type": "string", + "minLength": 1, + "description": "Column Title" + }, + "uidt": { + "$ref": "#/components/schemas/FieldTypeEnum" + }, + "description": { + "$ref": "#/components/schemas/FieldTypeDescription" + }, + "cdf": { + "$ref": "#/components/schemas/FieldTypeDefaultValue" + }, + "pv": { + "$ref": "#/components/schemas/FieldTypePrimaryValue" + }, + "rqd": { + "$ref": "#/components/schemas/FieldTypeRequired" + }, + "colOptions": { + "$ref": "#/components/schemas/FieldTypeMetaButton" + } + }, + "required": [ + "title" + ] + }, + "FieldTypeFormula": { + "type": "object", + "properties": { + "title": { + "maxLength": 255, + "type": "string", + "minLength": 1, + "description": "Column Title" + }, + "formula_raw": { + "type": "string", + "description": "Formula to compute the value of this column. You can use other columns in the same table to compute the value using moustache syntax. Example: `{col1} + {col2}`" + }, + "uidt": { + "$ref": "#/components/schemas/FieldTypeEnum" + }, + "description": { + "$ref": "#/components/schemas/FieldTypeDescription" + }, + "pv": { + "$ref": "#/components/schemas/FieldTypePrimaryValue" + } + }, + "required": [ + "title", + "formula_raw" + ] + }, + "FieldTypeBarcode": { + "type": "object", + "properties": { + "title": { + "maxLength": 255, + "type": "string", + "minLength": 1, + "description": "Column Title" + }, + "uidt": { + "$ref": "#/components/schemas/FieldTypeEnum" + }, + "description": { + "$ref": "#/components/schemas/FieldTypeDescription" + }, + "pv": { + "$ref": "#/components/schemas/FieldTypePrimaryValue" + }, + "colOptions": { + "$ref": "#/components/schemas/FieldTypeMetaBarcode" + } + }, + "required": [ + "title", + "colOptions" + ] + }, + "FieldTypeQrCode": { + "type": "object", + "properties": { + "title": { + "maxLength": 255, + "type": "string", + "minLength": 1, + "description": "Column Title" + }, + "uidt": { + "$ref": "#/components/schemas/FieldTypeEnum" + }, + "description": { + "$ref": "#/components/schemas/FieldTypeDescription" + }, + "pv": { + "$ref": "#/components/schemas/FieldTypePrimaryValue" + }, + "colOptions": { + "$ref": "#/components/schemas/FieldTypeMetaQrCode" + } + }, + "required": [ + "title", + "colOptions" + ] + }, + "FieldTypeLinks": { + "type": "object", + "properties": { + "title": { + "maxLength": 255, + "type": "string", + "minLength": 1, + "description": "Column Title" + }, + "uidt": { + "$ref": "#/components/schemas/FieldTypeEnum" + }, + "description": { + "$ref": "#/components/schemas/FieldTypeDescription" + }, + "pv": { + "$ref": "#/components/schemas/FieldTypePrimaryValue" + }, + "rqd": { + "$ref": "#/components/schemas/FieldTypeRequired" + }, + "colOptions": { + "$ref": "#/components/schemas/FieldTypeMetaLinks" + } + }, + "required": [ + "title", + "colOptions" + ] + }, + "FieldTypeLinkToAnotherRecord": { + "type": "object", + "properties": { + "title": { + "maxLength": 255, + "type": "string", + "minLength": 1, + "description": "Column Title" + }, + "uidt": { + "$ref": "#/components/schemas/FieldTypeEnum" + }, + "description": { + "$ref": "#/components/schemas/FieldTypeDescription" + }, + "pv": { + "$ref": "#/components/schemas/FieldTypePrimaryValue" + }, + "rqd": { + "$ref": "#/components/schemas/FieldTypeRequired" + }, + "colOptions": { + "$ref": "#/components/schemas/FieldTypeMetaLinks" + } + }, + "required": [ + "title", + "colOptions" + ] + }, + "FieldTypeLookup": { + "type": "object", + "properties": { + "title": { + "maxLength": 255, + "type": "string", + "minLength": 1, + "description": "Column Title" + }, + "uidt": { + "$ref": "#/components/schemas/FieldTypeEnum" + }, + "description": { + "$ref": "#/components/schemas/FieldTypeDescription" + }, + "pv": { + "$ref": "#/components/schemas/FieldTypePrimaryValue" + }, + "colOptions": { + "$ref": "#/components/schemas/FieldTypeMetaLookup" + } + }, + "required": [ + "title", + "colOptions" + ] + }, + "FieldTypeRollup": { + "type": "object", + "properties": { + "title": { + "maxLength": 255, + "type": "string", + "minLength": 1, + "description": "Column Title" + }, + "uidt": { + "$ref": "#/components/schemas/FieldTypeEnum" + }, + "description": { + "$ref": "#/components/schemas/FieldTypeDescription" + }, + "pv": { + "$ref": "#/components/schemas/FieldTypePrimaryValue" + }, + "colOptions": { + "$ref": "#/components/schemas/FieldTypeMetaRollup" + } + }, + "required": [ + "title", + "colOptions" + ] + }, + "FieldTypeID": { + "type": "object", + "description": "System field. Unique record ID.", + "properties": { + "title": { + "maxLength": 255, + "type": "string", + "minLength": 1, + "description": "Column Title" + }, + "uidt": { + "$ref": "#/components/schemas/FieldTypeEnum" + }, + "description": { + "$ref": "#/components/schemas/FieldTypeDescription" + }, + "pv": { + "$ref": "#/components/schemas/FieldTypePrimaryValue" + } + }, + "required": [ + "title" + ] + }, + "FieldTypeCreatedTime": { + "type": "object", + "description": "System field. Time when the record was created.", + "properties": { + "title": { + "maxLength": 255, + "type": "string", + "minLength": 1, + "description": "Column Title" + }, + "uidt": { + "$ref": "#/components/schemas/FieldTypeEnum" + }, + "description": { + "$ref": "#/components/schemas/FieldTypeDescription" + }, + "pv": { + "$ref": "#/components/schemas/FieldTypePrimaryValue" + } + }, + "required": [ + "title" + ] + }, + "FieldTypeLastModifiedTime": { + "type": "object", + "description": "System field. Time when the record was last modified.", + "properties": { + "title": { + "maxLength": 255, + "type": "string", + "minLength": 1, + "description": "Column Title" + }, + "uidt": { + "$ref": "#/components/schemas/FieldTypeEnum" + }, + "description": { + "$ref": "#/components/schemas/FieldTypeDescription" + }, + "pv": { + "$ref": "#/components/schemas/FieldTypePrimaryValue" + } + }, + "required": [ + "title" + ] + }, + "FieldTypeCreatedBy": { + "type": "object", + "description": "System field. User who created the record.", + "properties": { + "title": { + "maxLength": 255, + "type": "string", + "minLength": 1, + "description": "Column Title" + }, + "uidt": { + "$ref": "#/components/schemas/FieldTypeEnum" + }, + "description": { + "$ref": "#/components/schemas/FieldTypeDescription" + }, + "pv": { + "$ref": "#/components/schemas/FieldTypePrimaryValue" + } + }, + "required": [ + "title" + ] + }, + "FieldTypeLastModifiedBy": { + "type": "object", + "description": "System field. User who last modified the record.", + "properties": { + "title": { + "maxLength": 255, + "type": "string", + "minLength": 1, + "description": "Column Title" + }, + "uidt": { + "$ref": "#/components/schemas/FieldTypeEnum" + }, + "description": { + "$ref": "#/components/schemas/FieldTypeDescription" + }, + "pv": { + "$ref": "#/components/schemas/FieldTypePrimaryValue" + } + }, + "required": [ + "title" + ] + }, + "FieldTypeGeoData": { + "type": "object", + "properties": { + "title": { + "maxLength": 255, + "type": "string", + "minLength": 1, + "description": "Column Title" + }, + "uidt": { + "$ref": "#/components/schemas/FieldTypeEnum" + }, + "description": { + "$ref": "#/components/schemas/FieldTypeDescription" + }, + "cdf": { + "$ref": "#/components/schemas/FieldTypeDefaultValue" + }, + "pv": { + "$ref": "#/components/schemas/FieldTypePrimaryValue" + }, + "rqd": { + "$ref": "#/components/schemas/FieldTypeRequired" + } + }, + "required": [ + "title" + ] + }, + "FieldTypeGeometry": { + "type": "object", + "properties": { + "title": { + "maxLength": 255, + "type": "string", + "minLength": 1, + "description": "Column Title" + }, + "uidt": { + "$ref": "#/components/schemas/FieldTypeEnum" + }, + "description": { + "$ref": "#/components/schemas/FieldTypeDescription" + }, + "cdf": { + "$ref": "#/components/schemas/FieldTypeDefaultValue" + }, + "pv": { + "$ref": "#/components/schemas/FieldTypePrimaryValue" + }, + "rqd": { + "$ref": "#/components/schemas/FieldTypeRequired" + } + }, + "required": [ + "title" + ] + }, + "FieldTypeJSON": { + "type": "object", + "properties": { + "title": { + "maxLength": 255, + "type": "string", + "minLength": 1, + "description": "Column Title" + }, + "uidt": { + "$ref": "#/components/schemas/FieldTypeEnum" + }, + "description": { + "$ref": "#/components/schemas/FieldTypeDescription" + }, + "cdf": { + "$ref": "#/components/schemas/FieldTypeDefaultValue" + }, + "pv": { + "$ref": "#/components/schemas/FieldTypePrimaryValue" + }, + "rqd": { + "$ref": "#/components/schemas/FieldTypeRequired" + } + }, + "required": [ + "title" + ] + }, + "FieldTypeSpecificDBType": { + "type": "object", + "properties": { + "title": { + "maxLength": 255, + "type": "string", + "minLength": 1, + "description": "Column Title" + }, + "uidt": { + "$ref": "#/components/schemas/FieldTypeEnum" + }, + "description": { + "$ref": "#/components/schemas/FieldTypeDescription" + }, + "cdf": { + "$ref": "#/components/schemas/FieldTypeDefaultValue" + }, + "pv": { + "$ref": "#/components/schemas/FieldTypePrimaryValue" + }, + "rqd": { + "$ref": "#/components/schemas/FieldTypeRequired" + } + }, + "required": [ + "title" + ] + }, + "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 base user" + } + }, + "title": "Organisation User Request Model", + "type": "object", + "x-stoplight": { + "id": "n484boi6jv3up" + } + }, + "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": "2x65v3n9xo8q3" + } + }, + "Password": { + "description": "Model for Password", + "example": "password123456789", + "examples": [ + "password123456789" + ], + "minLength": 8, + "title": "Password Model", + "type": "string", + "x-stoplight": { + "id": "s7gk265anpyc7" + } + }, + "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", @@ -18729,8 +20219,8 @@ "id": "p1g7xrgdsn540" } }, - "StringOrNullOrBooleanOrNumber": { - "description": "Model for StringOrNullOrBooleanOrNumber", + "FieldDefaultValue": { + "description": "Model for FieldDefaultValue", "examples": [ "string" ], @@ -18748,7 +20238,7 @@ "type": "number" } ], - "title": "StringOrNullOrBooleanOrNumber Model" + "title": "FieldDefaultValue Model" }, "Table": { "description": "Model for Table", @@ -19418,6 +20908,13 @@ } ], "properties": { + "table_name": { + "description": "Table name", + "example": "my_table", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, "columns": { "description": "The column models in this table", "items": { @@ -19434,13 +20931,6 @@ "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",