Merge branch 'fix/open-api-search' of github.com:Budibase/budibase into examples/nextjs
This commit is contained in:
mike12345567
commit
493c2ec266
|
|
@ -503,6 +503,71 @@
|
|||
"data"
|
||||
]
|
||||
},
|
||||
"applicationSearch": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"data": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"name": {
|
||||
"description": "The name of the app.",
|
||||
"type": "string"
|
||||
},
|
||||
"url": {
|
||||
"description": "The URL by which the app is accessed, this must be URL encoded.",
|
||||
"type": "string"
|
||||
},
|
||||
"_id": {
|
||||
"description": "The ID of the app.",
|
||||
"type": "string"
|
||||
},
|
||||
"status": {
|
||||
"description": "The status of the app, stating it if is the development or published version.",
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"development",
|
||||
"published"
|
||||
]
|
||||
},
|
||||
"createdAt": {
|
||||
"description": "States when the app was created, will be constant. Stored in ISO format.",
|
||||
"type": "string"
|
||||
},
|
||||
"updatedAt": {
|
||||
"description": "States the last time the app was updated - stored in ISO format.",
|
||||
"type": "string"
|
||||
},
|
||||
"version": {
|
||||
"description": "States the version of the Budibase client this app is currently based on.",
|
||||
"type": "string"
|
||||
},
|
||||
"tenantId": {
|
||||
"description": "In a multi-tenant environment this will state the tenant this app is within.",
|
||||
"type": "string"
|
||||
},
|
||||
"lockedBy": {
|
||||
"description": "The user this app is currently being built by.",
|
||||
"type": "object"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"_id",
|
||||
"name",
|
||||
"url",
|
||||
"status",
|
||||
"createdAt",
|
||||
"updatedAt",
|
||||
"version"
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"data"
|
||||
]
|
||||
},
|
||||
"row": {
|
||||
"description": "The row to be created/updated, based on the table schema.",
|
||||
"type": "object",
|
||||
|
|
@ -980,6 +1045,221 @@
|
|||
"data"
|
||||
]
|
||||
},
|
||||
"tableSearch": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"data": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"description": "The table to be created/updated.",
|
||||
"type": "object",
|
||||
"required": [
|
||||
"name",
|
||||
"schema",
|
||||
"_id"
|
||||
],
|
||||
"properties": {
|
||||
"name": {
|
||||
"description": "The name of the table.",
|
||||
"type": "string"
|
||||
},
|
||||
"primaryDisplay": {
|
||||
"type": "string",
|
||||
"description": "The name of the column which should be used in relationship tags when relating to this table."
|
||||
},
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"additionalProperties": {
|
||||
"oneOf": [
|
||||
{
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"type": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"link"
|
||||
],
|
||||
"description": "A relationship column."
|
||||
},
|
||||
"constraints": {
|
||||
"type": "object",
|
||||
"description": "A constraint can be applied to the column which will be validated against when a row is saved.",
|
||||
"properties": {
|
||||
"type": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"string",
|
||||
"number",
|
||||
"object",
|
||||
"boolean"
|
||||
]
|
||||
},
|
||||
"presence": {
|
||||
"type": "boolean",
|
||||
"description": "Defines whether the column is required or not."
|
||||
}
|
||||
}
|
||||
},
|
||||
"name": {
|
||||
"type": "string",
|
||||
"description": "The name of the column."
|
||||
},
|
||||
"autocolumn": {
|
||||
"type": "boolean",
|
||||
"description": "Defines whether the column is automatically generated."
|
||||
},
|
||||
"fieldName": {
|
||||
"type": "string",
|
||||
"description": "The name of the column which a relationship column is related to in another table."
|
||||
},
|
||||
"tableId": {
|
||||
"type": "string",
|
||||
"description": "The ID of the table which a relationship column is related to."
|
||||
},
|
||||
"relationshipType": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"one-to-many",
|
||||
"many-to-one",
|
||||
"many-to-many"
|
||||
],
|
||||
"description": "Defines the type of relationship that this column will be used for."
|
||||
},
|
||||
"through": {
|
||||
"type": "string",
|
||||
"description": "When using a SQL table that contains many to many relationships this defines the table the relationships are linked through."
|
||||
},
|
||||
"foreignKey": {
|
||||
"type": "string",
|
||||
"description": "When using a SQL table that contains a one to many relationship this defines the foreign key."
|
||||
},
|
||||
"throughFrom": {
|
||||
"type": "string",
|
||||
"description": "When using a SQL table that utilises a through table, this defines the primary key in the through table for this table."
|
||||
},
|
||||
"throughTo": {
|
||||
"type": "string",
|
||||
"description": "When using a SQL table that utilises a through table, this defines the primary key in the through table for the related table."
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"type": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"formula"
|
||||
],
|
||||
"description": "A formula column."
|
||||
},
|
||||
"constraints": {
|
||||
"type": "object",
|
||||
"description": "A constraint can be applied to the column which will be validated against when a row is saved.",
|
||||
"properties": {
|
||||
"type": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"string",
|
||||
"number",
|
||||
"object",
|
||||
"boolean"
|
||||
]
|
||||
},
|
||||
"presence": {
|
||||
"type": "boolean",
|
||||
"description": "Defines whether the column is required or not."
|
||||
}
|
||||
}
|
||||
},
|
||||
"name": {
|
||||
"type": "string",
|
||||
"description": "The name of the column."
|
||||
},
|
||||
"autocolumn": {
|
||||
"type": "boolean",
|
||||
"description": "Defines whether the column is automatically generated."
|
||||
},
|
||||
"formula": {
|
||||
"type": "string",
|
||||
"description": "Defines a Handlebars or JavaScript formula to use, note that Javascript formulas are expected to be provided in the base64 format."
|
||||
},
|
||||
"formulaType": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"static",
|
||||
"dynamic"
|
||||
],
|
||||
"description": "Defines whether this is a static or dynamic formula."
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"type": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"string",
|
||||
"longform",
|
||||
"options",
|
||||
"number",
|
||||
"boolean",
|
||||
"array",
|
||||
"datetime",
|
||||
"attachment",
|
||||
"link",
|
||||
"formula",
|
||||
"auto",
|
||||
"json",
|
||||
"internal"
|
||||
],
|
||||
"description": "Defines the type of the column, most explain themselves, a link column is a relationship."
|
||||
},
|
||||
"constraints": {
|
||||
"type": "object",
|
||||
"description": "A constraint can be applied to the column which will be validated against when a row is saved.",
|
||||
"properties": {
|
||||
"type": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"string",
|
||||
"number",
|
||||
"object",
|
||||
"boolean"
|
||||
]
|
||||
},
|
||||
"presence": {
|
||||
"type": "boolean",
|
||||
"description": "Defines whether the column is required or not."
|
||||
}
|
||||
}
|
||||
},
|
||||
"name": {
|
||||
"type": "string",
|
||||
"description": "The name of the column."
|
||||
},
|
||||
"autocolumn": {
|
||||
"type": "boolean",
|
||||
"description": "Defines whether the column is automatically generated."
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"_id": {
|
||||
"description": "The ID of the table.",
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"data"
|
||||
]
|
||||
},
|
||||
"executeQuery": {
|
||||
"description": "The query body must contain the required parameters for the query, this depends on query type, setup and bindings.",
|
||||
"type": "object",
|
||||
|
|
@ -1074,6 +1354,71 @@
|
|||
"_id"
|
||||
]
|
||||
},
|
||||
"querySearch": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"data": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"_id": {
|
||||
"description": "The ID of the query.",
|
||||
"type": "string"
|
||||
},
|
||||
"datasourceId": {
|
||||
"description": "The ID of the data source the query belongs to.",
|
||||
"type": "string"
|
||||
},
|
||||
"parameters": {
|
||||
"description": "The bindings which are required to perform this query.",
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"fields": {
|
||||
"description": "The fields that are used to perform this query, e.g. the sql statement",
|
||||
"type": "object"
|
||||
},
|
||||
"queryVerb": {
|
||||
"description": "The verb that describes this query.",
|
||||
"enum": [
|
||||
"create",
|
||||
"read",
|
||||
"update",
|
||||
"delete"
|
||||
]
|
||||
},
|
||||
"name": {
|
||||
"description": "The name of the query.",
|
||||
"type": "string"
|
||||
},
|
||||
"schema": {
|
||||
"description": "The schema of the data returned when the query is executed.",
|
||||
"type": "object"
|
||||
},
|
||||
"transformer": {
|
||||
"description": "The JavaScript transformer function, applied after the query responds with data.",
|
||||
"type": "string"
|
||||
},
|
||||
"readable": {
|
||||
"description": "Whether the query has readable data.",
|
||||
"type": "boolean"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"name",
|
||||
"schema",
|
||||
"_id"
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"data"
|
||||
]
|
||||
},
|
||||
"user": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
|
|
@ -1215,6 +1560,86 @@
|
|||
"data"
|
||||
]
|
||||
},
|
||||
"userSearch": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"data": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"email": {
|
||||
"description": "The email address of the user, this must be unique.",
|
||||
"type": "string"
|
||||
},
|
||||
"password": {
|
||||
"description": "The password of the user if using password based login - this will never be returned. This can be left out of subsequent requests (updates) and will be enriched back into the user structure.",
|
||||
"type": "string"
|
||||
},
|
||||
"status": {
|
||||
"description": "The status of the user, if they are active.",
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"active"
|
||||
]
|
||||
},
|
||||
"firstName": {
|
||||
"description": "The first name of the user",
|
||||
"type": "string"
|
||||
},
|
||||
"lastName": {
|
||||
"description": "The last name of the user",
|
||||
"type": "string"
|
||||
},
|
||||
"forceResetPassword": {
|
||||
"description": "If set to true forces the user to reset their password on first login.",
|
||||
"type": "boolean"
|
||||
},
|
||||
"builder": {
|
||||
"description": "Describes if the user is a builder user or not.",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"global": {
|
||||
"description": "If set to true the user will be able to build any app in the system.",
|
||||
"type": "boolean"
|
||||
}
|
||||
}
|
||||
},
|
||||
"admin": {
|
||||
"description": "Describes if the user is an admin user or not.",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"global": {
|
||||
"description": "If set to true the user will be able to administrate the system.",
|
||||
"type": "boolean"
|
||||
}
|
||||
}
|
||||
},
|
||||
"roles": {
|
||||
"description": "Contains the roles of the user per app (assuming they are not a builder user).",
|
||||
"type": "object",
|
||||
"additionalProperties": {
|
||||
"type": "string",
|
||||
"description": "A map of app ID (production app ID, minus the _dev component) to a role ID, e.g. ADMIN."
|
||||
}
|
||||
},
|
||||
"_id": {
|
||||
"description": "The ID of the user.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"email",
|
||||
"roles",
|
||||
"_id"
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"data"
|
||||
]
|
||||
},
|
||||
"nameSearch": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
|
|
@ -1399,18 +1824,7 @@
|
|||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"data"
|
||||
],
|
||||
"properties": {
|
||||
"data": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/components/schemas/application"
|
||||
}
|
||||
}
|
||||
}
|
||||
"$ref": "#/components/schemas/applicationSearch"
|
||||
},
|
||||
"examples": {
|
||||
"applications": {
|
||||
|
|
@ -1498,18 +1912,7 @@
|
|||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"data"
|
||||
],
|
||||
"properties": {
|
||||
"data": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/components/schemas/query"
|
||||
}
|
||||
}
|
||||
}
|
||||
"$ref": "#/components/schemas/querySearch"
|
||||
},
|
||||
"examples": {
|
||||
"queries": {
|
||||
|
|
@ -2025,18 +2428,7 @@
|
|||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"data"
|
||||
],
|
||||
"properties": {
|
||||
"data": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/components/schemas/table"
|
||||
}
|
||||
}
|
||||
}
|
||||
"$ref": "#/components/schemas/tableSearch"
|
||||
},
|
||||
"examples": {
|
||||
"tables": {
|
||||
|
|
@ -2203,18 +2595,7 @@
|
|||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"data"
|
||||
],
|
||||
"properties": {
|
||||
"data": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/components/schemas/user"
|
||||
}
|
||||
}
|
||||
}
|
||||
"$ref": "#/components/schemas/userSearch"
|
||||
},
|
||||
"examples": {
|
||||
"users": {
|
||||
|
|
|
|||
|
|
@ -360,6 +360,58 @@ components:
|
|||
- version
|
||||
required:
|
||||
- data
|
||||
applicationSearch:
|
||||
type: object
|
||||
properties:
|
||||
data:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
name:
|
||||
description: The name of the app.
|
||||
type: string
|
||||
url:
|
||||
description: The URL by which the app is accessed, this must be URL encoded.
|
||||
type: string
|
||||
_id:
|
||||
description: The ID of the app.
|
||||
type: string
|
||||
status:
|
||||
description: The status of the app, stating it if is the development or
|
||||
published version.
|
||||
type: string
|
||||
enum:
|
||||
- development
|
||||
- published
|
||||
createdAt:
|
||||
description: States when the app was created, will be constant. Stored in ISO
|
||||
format.
|
||||
type: string
|
||||
updatedAt:
|
||||
description: States the last time the app was updated - stored in ISO format.
|
||||
type: string
|
||||
version:
|
||||
description: States the version of the Budibase client this app is currently
|
||||
based on.
|
||||
type: string
|
||||
tenantId:
|
||||
description: In a multi-tenant environment this will state the tenant this app
|
||||
is within.
|
||||
type: string
|
||||
lockedBy:
|
||||
description: The user this app is currently being built by.
|
||||
type: object
|
||||
required:
|
||||
- _id
|
||||
- name
|
||||
- url
|
||||
- status
|
||||
- createdAt
|
||||
- updatedAt
|
||||
- version
|
||||
required:
|
||||
- data
|
||||
row:
|
||||
description: The row to be created/updated, based on the table schema.
|
||||
type: object
|
||||
|
|
@ -730,6 +782,175 @@ components:
|
|||
type: string
|
||||
required:
|
||||
- data
|
||||
tableSearch:
|
||||
type: object
|
||||
properties:
|
||||
data:
|
||||
type: array
|
||||
items:
|
||||
description: The table to be created/updated.
|
||||
type: object
|
||||
required:
|
||||
- name
|
||||
- schema
|
||||
- _id
|
||||
properties:
|
||||
name:
|
||||
description: The name of the table.
|
||||
type: string
|
||||
primaryDisplay:
|
||||
type: string
|
||||
description: The name of the column which should be used in relationship tags
|
||||
when relating to this table.
|
||||
schema:
|
||||
type: object
|
||||
additionalProperties:
|
||||
oneOf:
|
||||
- type: object
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
enum:
|
||||
- link
|
||||
description: A relationship column.
|
||||
constraints:
|
||||
type: object
|
||||
description: A constraint can be applied to the column which will be validated
|
||||
against when a row is saved.
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
enum:
|
||||
- string
|
||||
- number
|
||||
- object
|
||||
- boolean
|
||||
presence:
|
||||
type: boolean
|
||||
description: Defines whether the column is required or not.
|
||||
name:
|
||||
type: string
|
||||
description: The name of the column.
|
||||
autocolumn:
|
||||
type: boolean
|
||||
description: Defines whether the column is automatically generated.
|
||||
fieldName:
|
||||
type: string
|
||||
description: The name of the column which a relationship column is related to in
|
||||
another table.
|
||||
tableId:
|
||||
type: string
|
||||
description: The ID of the table which a relationship column is related to.
|
||||
relationshipType:
|
||||
type: string
|
||||
enum:
|
||||
- one-to-many
|
||||
- many-to-one
|
||||
- many-to-many
|
||||
description: Defines the type of relationship that this column will be used for.
|
||||
through:
|
||||
type: string
|
||||
description: When using a SQL table that contains many to many relationships
|
||||
this defines the table the relationships are linked
|
||||
through.
|
||||
foreignKey:
|
||||
type: string
|
||||
description: When using a SQL table that contains a one to many relationship
|
||||
this defines the foreign key.
|
||||
throughFrom:
|
||||
type: string
|
||||
description: When using a SQL table that utilises a through table, this defines
|
||||
the primary key in the through table for this table.
|
||||
throughTo:
|
||||
type: string
|
||||
description: When using a SQL table that utilises a through table, this defines
|
||||
the primary key in the through table for the related
|
||||
table.
|
||||
- type: object
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
enum:
|
||||
- formula
|
||||
description: A formula column.
|
||||
constraints:
|
||||
type: object
|
||||
description: A constraint can be applied to the column which will be validated
|
||||
against when a row is saved.
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
enum:
|
||||
- string
|
||||
- number
|
||||
- object
|
||||
- boolean
|
||||
presence:
|
||||
type: boolean
|
||||
description: Defines whether the column is required or not.
|
||||
name:
|
||||
type: string
|
||||
description: The name of the column.
|
||||
autocolumn:
|
||||
type: boolean
|
||||
description: Defines whether the column is automatically generated.
|
||||
formula:
|
||||
type: string
|
||||
description: Defines a Handlebars or JavaScript formula to use, note that
|
||||
Javascript formulas are expected to be provided in
|
||||
the base64 format.
|
||||
formulaType:
|
||||
type: string
|
||||
enum:
|
||||
- static
|
||||
- dynamic
|
||||
description: Defines whether this is a static or dynamic formula.
|
||||
- type: object
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
enum:
|
||||
- string
|
||||
- longform
|
||||
- options
|
||||
- number
|
||||
- boolean
|
||||
- array
|
||||
- datetime
|
||||
- attachment
|
||||
- link
|
||||
- formula
|
||||
- auto
|
||||
- json
|
||||
- internal
|
||||
description: Defines the type of the column, most explain themselves, a link
|
||||
column is a relationship.
|
||||
constraints:
|
||||
type: object
|
||||
description: A constraint can be applied to the column which will be validated
|
||||
against when a row is saved.
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
enum:
|
||||
- string
|
||||
- number
|
||||
- object
|
||||
- boolean
|
||||
presence:
|
||||
type: boolean
|
||||
description: Defines whether the column is required or not.
|
||||
name:
|
||||
type: string
|
||||
description: The name of the column.
|
||||
autocolumn:
|
||||
type: boolean
|
||||
description: Defines whether the column is automatically generated.
|
||||
_id:
|
||||
description: The ID of the table.
|
||||
type: string
|
||||
required:
|
||||
- data
|
||||
executeQuery:
|
||||
description: The query body must contain the required parameters for the query,
|
||||
this depends on query type, setup and bindings.
|
||||
|
|
@ -803,6 +1024,55 @@ components:
|
|||
- name
|
||||
- schema
|
||||
- _id
|
||||
querySearch:
|
||||
type: object
|
||||
properties:
|
||||
data:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
_id:
|
||||
description: The ID of the query.
|
||||
type: string
|
||||
datasourceId:
|
||||
description: The ID of the data source the query belongs to.
|
||||
type: string
|
||||
parameters:
|
||||
description: The bindings which are required to perform this query.
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
fields:
|
||||
description: The fields that are used to perform this query, e.g. the sql
|
||||
statement
|
||||
type: object
|
||||
queryVerb:
|
||||
description: The verb that describes this query.
|
||||
enum:
|
||||
- create
|
||||
- read
|
||||
- update
|
||||
- delete
|
||||
name:
|
||||
description: The name of the query.
|
||||
type: string
|
||||
schema:
|
||||
description: The schema of the data returned when the query is executed.
|
||||
type: object
|
||||
transformer:
|
||||
description: The JavaScript transformer function, applied after the query
|
||||
responds with data.
|
||||
type: string
|
||||
readable:
|
||||
description: Whether the query has readable data.
|
||||
type: boolean
|
||||
required:
|
||||
- name
|
||||
- schema
|
||||
- _id
|
||||
required:
|
||||
- data
|
||||
user:
|
||||
type: object
|
||||
properties:
|
||||
|
|
@ -916,6 +1186,69 @@ components:
|
|||
- _id
|
||||
required:
|
||||
- data
|
||||
userSearch:
|
||||
type: object
|
||||
properties:
|
||||
data:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
email:
|
||||
description: The email address of the user, this must be unique.
|
||||
type: string
|
||||
password:
|
||||
description: The password of the user if using password based login - this will
|
||||
never be returned. This can be left out of subsequent requests
|
||||
(updates) and will be enriched back into the user structure.
|
||||
type: string
|
||||
status:
|
||||
description: The status of the user, if they are active.
|
||||
type: string
|
||||
enum:
|
||||
- active
|
||||
firstName:
|
||||
description: The first name of the user
|
||||
type: string
|
||||
lastName:
|
||||
description: The last name of the user
|
||||
type: string
|
||||
forceResetPassword:
|
||||
description: If set to true forces the user to reset their password on first
|
||||
login.
|
||||
type: boolean
|
||||
builder:
|
||||
description: Describes if the user is a builder user or not.
|
||||
type: object
|
||||
properties:
|
||||
global:
|
||||
description: If set to true the user will be able to build any app in the
|
||||
system.
|
||||
type: boolean
|
||||
admin:
|
||||
description: Describes if the user is an admin user or not.
|
||||
type: object
|
||||
properties:
|
||||
global:
|
||||
description: If set to true the user will be able to administrate the system.
|
||||
type: boolean
|
||||
roles:
|
||||
description: Contains the roles of the user per app (assuming they are not a
|
||||
builder user).
|
||||
type: object
|
||||
additionalProperties:
|
||||
type: string
|
||||
description: A map of app ID (production app ID, minus the _dev component) to a
|
||||
role ID, e.g. ADMIN.
|
||||
_id:
|
||||
description: The ID of the user.
|
||||
type: string
|
||||
required:
|
||||
- email
|
||||
- roles
|
||||
- _id
|
||||
required:
|
||||
- data
|
||||
nameSearch:
|
||||
type: object
|
||||
properties:
|
||||
|
|
@ -1028,14 +1361,7 @@ paths:
|
|||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
required:
|
||||
- data
|
||||
properties:
|
||||
data:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/application"
|
||||
$ref: "#/components/schemas/applicationSearch"
|
||||
examples:
|
||||
applications:
|
||||
$ref: "#/components/examples/applications"
|
||||
|
|
@ -1087,14 +1413,7 @@ paths:
|
|||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
required:
|
||||
- data
|
||||
properties:
|
||||
data:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/query"
|
||||
$ref: "#/components/schemas/querySearch"
|
||||
examples:
|
||||
queries:
|
||||
$ref: "#/components/examples/queries"
|
||||
|
|
@ -1419,14 +1738,7 @@ paths:
|
|||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
required:
|
||||
- data
|
||||
properties:
|
||||
data:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/table"
|
||||
$ref: "#/components/schemas/tableSearch"
|
||||
examples:
|
||||
tables:
|
||||
$ref: "#/components/examples/tables"
|
||||
|
|
@ -1524,14 +1836,7 @@ paths:
|
|||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
required:
|
||||
- data
|
||||
properties:
|
||||
data:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/user"
|
||||
$ref: "#/components/schemas/userSearch"
|
||||
examples:
|
||||
users:
|
||||
$ref: "#/components/examples/users"
|
||||
|
|
|
|||
|
|
@ -98,4 +98,10 @@ module.exports = new Resource()
|
|||
applicationOutput: object({
|
||||
data: applicationOutputSchema,
|
||||
}),
|
||||
applicationSearch: object({
|
||||
data: {
|
||||
type: "array",
|
||||
items: applicationOutputSchema,
|
||||
},
|
||||
}),
|
||||
})
|
||||
|
|
|
|||
|
|
@ -186,4 +186,10 @@ module.exports = new Resource()
|
|||
executeQuery: executeQuerySchema,
|
||||
executeQueryOutput: executeQueryOutputSchema,
|
||||
query: querySchema,
|
||||
querySearch: object({
|
||||
data: {
|
||||
type: "array",
|
||||
items: querySchema,
|
||||
},
|
||||
}),
|
||||
})
|
||||
|
|
|
|||
|
|
@ -188,4 +188,10 @@ module.exports = new Resource()
|
|||
tableOutput: object({
|
||||
data: tableOutputSchema,
|
||||
}),
|
||||
tableSearch: object({
|
||||
data: {
|
||||
type: "array",
|
||||
items: tableOutputSchema,
|
||||
},
|
||||
}),
|
||||
})
|
||||
|
|
|
|||
|
|
@ -123,4 +123,10 @@ module.exports = new Resource()
|
|||
userOutput: object({
|
||||
data: userOutputSchema,
|
||||
}),
|
||||
userSearch: object({
|
||||
data: {
|
||||
type: "array",
|
||||
items: userOutputSchema,
|
||||
},
|
||||
}),
|
||||
})
|
||||
|
|
|
|||
|
|
@ -33,11 +33,11 @@ exports.handleRequest = handleRequest
|
|||
exports.patch = async ctx => {
|
||||
const inputs = ctx.request.body
|
||||
const tableId = ctx.params.tableId
|
||||
const id = breakRowIdField(inputs._id)
|
||||
const id = inputs._id
|
||||
// don't save the ID to db
|
||||
delete inputs._id
|
||||
return handleRequest(DataSourceOperation.UPDATE, tableId, {
|
||||
id,
|
||||
id: breakRowIdField(id),
|
||||
row: inputs,
|
||||
})
|
||||
}
|
||||
|
|
@ -67,7 +67,7 @@ exports.find = async ctx => {
|
|||
const id = ctx.params.rowId
|
||||
const tableId = ctx.params.tableId
|
||||
const response = await handleRequest(DataSourceOperation.READ, tableId, {
|
||||
id,
|
||||
id: breakRowIdField(id),
|
||||
})
|
||||
return response ? response[0] : response
|
||||
}
|
||||
|
|
@ -76,7 +76,7 @@ exports.destroy = async ctx => {
|
|||
const tableId = ctx.params.tableId
|
||||
const id = ctx.request.body._id
|
||||
const { row } = await handleRequest(DataSourceOperation.DELETE, tableId, {
|
||||
id,
|
||||
id: breakRowIdField(id),
|
||||
})
|
||||
return { response: { ok: true }, row }
|
||||
}
|
||||
|
|
|
|||
|
|
@ -135,14 +135,7 @@ read.push(new Endpoint("get", "/applications/:appId", controller.read))
|
|||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* required:
|
||||
* - data
|
||||
* properties:
|
||||
* data:
|
||||
* type: array
|
||||
* items:
|
||||
* $ref: '#/components/schemas/application'
|
||||
* $ref: '#/components/schemas/applicationSearch'
|
||||
* examples:
|
||||
* applications:
|
||||
* $ref: '#/components/examples/applications'
|
||||
|
|
|
|||
|
|
@ -60,14 +60,7 @@ write.push(new Endpoint("post", "/queries/:queryId", controller.execute))
|
|||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* required:
|
||||
* - data
|
||||
* properties:
|
||||
* data:
|
||||
* type: array
|
||||
* items:
|
||||
* $ref: '#/components/schemas/query'
|
||||
* $ref: '#/components/schemas/querySearch'
|
||||
* examples:
|
||||
* queries:
|
||||
* $ref: '#/components/examples/queries'
|
||||
|
|
|
|||
|
|
@ -148,14 +148,7 @@ read.push(new Endpoint("get", "/tables/:tableId", controller.read))
|
|||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* required:
|
||||
* - data
|
||||
* properties:
|
||||
* data:
|
||||
* type: array
|
||||
* items:
|
||||
* $ref: '#/components/schemas/table'
|
||||
* $ref: '#/components/schemas/tableSearch'
|
||||
* examples:
|
||||
* tables:
|
||||
* $ref: '#/components/examples/tables'
|
||||
|
|
|
|||
|
|
@ -123,14 +123,7 @@ read.push(new Endpoint("get", "/users/:userId", controller.read))
|
|||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* required:
|
||||
* - data
|
||||
* properties:
|
||||
* data:
|
||||
* type: array
|
||||
* items:
|
||||
* $ref: '#/components/schemas/user'
|
||||
* $ref: '#/components/schemas/userSearch'
|
||||
* examples:
|
||||
* users:
|
||||
* $ref: '#/components/examples/users'
|
||||
|
|
|
|||
|
|
@ -95,9 +95,7 @@ export interface paths {
|
|||
/** Returns the applications that were found based on the search parameters. */
|
||||
200: {
|
||||
content: {
|
||||
"application/json": {
|
||||
data: components["schemas"]["application"][]
|
||||
}
|
||||
"application/json": components["schemas"]["applicationSearch"]
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -149,9 +147,7 @@ export interface paths {
|
|||
/** Returns the queries found based on the search parameters. */
|
||||
200: {
|
||||
content: {
|
||||
"application/json": {
|
||||
data: components["schemas"]["query"][]
|
||||
}
|
||||
"application/json": components["schemas"]["querySearch"]
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -449,9 +445,7 @@ export interface paths {
|
|||
/** Returns the found tables, based on the search parameters. */
|
||||
200: {
|
||||
content: {
|
||||
"application/json": {
|
||||
data: components["schemas"]["table"][]
|
||||
}
|
||||
"application/json": components["schemas"]["tableSearch"]
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -541,9 +535,7 @@ export interface paths {
|
|||
/** Returns the found users based on search parameters. */
|
||||
200: {
|
||||
content: {
|
||||
"application/json": {
|
||||
data: components["schemas"]["user"][]
|
||||
}
|
||||
"application/json": components["schemas"]["userSearch"]
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -589,6 +581,31 @@ export interface components {
|
|||
lockedBy?: { [key: string]: unknown }
|
||||
}
|
||||
}
|
||||
applicationSearch: {
|
||||
data: {
|
||||
/** @description The name of the app. */
|
||||
name: string
|
||||
/** @description The URL by which the app is accessed, this must be URL encoded. */
|
||||
url: string
|
||||
/** @description The ID of the app. */
|
||||
_id: string
|
||||
/**
|
||||
* @description The status of the app, stating it if is the development or published version.
|
||||
* @enum {string}
|
||||
*/
|
||||
status: "development" | "published"
|
||||
/** @description States when the app was created, will be constant. Stored in ISO format. */
|
||||
createdAt: string
|
||||
/** @description States the last time the app was updated - stored in ISO format. */
|
||||
updatedAt: string
|
||||
/** @description States the version of the Budibase client this app is currently based on. */
|
||||
version: string
|
||||
/** @description In a multi-tenant environment this will state the tenant this app is within. */
|
||||
tenantId?: string
|
||||
/** @description The user this app is currently being built by. */
|
||||
lockedBy?: { [key: string]: unknown }
|
||||
}[]
|
||||
}
|
||||
/** @description The row to be created/updated, based on the table schema. */
|
||||
row: { [key: string]: unknown }
|
||||
searchOutput: {
|
||||
|
|
@ -817,6 +834,113 @@ export interface components {
|
|||
_id: string
|
||||
}
|
||||
}
|
||||
tableSearch: {
|
||||
data: {
|
||||
/** @description The name of the table. */
|
||||
name: string
|
||||
/** @description The name of the column which should be used in relationship tags when relating to this table. */
|
||||
primaryDisplay?: string
|
||||
schema: {
|
||||
[key: string]:
|
||||
| {
|
||||
/**
|
||||
* @description A relationship column.
|
||||
* @enum {string}
|
||||
*/
|
||||
type?: "link"
|
||||
/** @description A constraint can be applied to the column which will be validated against when a row is saved. */
|
||||
constraints?: {
|
||||
/** @enum {string} */
|
||||
type?: "string" | "number" | "object" | "boolean"
|
||||
/** @description Defines whether the column is required or not. */
|
||||
presence?: boolean
|
||||
}
|
||||
/** @description The name of the column. */
|
||||
name?: string
|
||||
/** @description Defines whether the column is automatically generated. */
|
||||
autocolumn?: boolean
|
||||
/** @description The name of the column which a relationship column is related to in another table. */
|
||||
fieldName?: string
|
||||
/** @description The ID of the table which a relationship column is related to. */
|
||||
tableId?: string
|
||||
/**
|
||||
* @description Defines the type of relationship that this column will be used for.
|
||||
* @enum {string}
|
||||
*/
|
||||
relationshipType?:
|
||||
| "one-to-many"
|
||||
| "many-to-one"
|
||||
| "many-to-many"
|
||||
/** @description When using a SQL table that contains many to many relationships this defines the table the relationships are linked through. */
|
||||
through?: string
|
||||
/** @description When using a SQL table that contains a one to many relationship this defines the foreign key. */
|
||||
foreignKey?: string
|
||||
/** @description When using a SQL table that utilises a through table, this defines the primary key in the through table for this table. */
|
||||
throughFrom?: string
|
||||
/** @description When using a SQL table that utilises a through table, this defines the primary key in the through table for the related table. */
|
||||
throughTo?: string
|
||||
}
|
||||
| {
|
||||
/**
|
||||
* @description A formula column.
|
||||
* @enum {string}
|
||||
*/
|
||||
type?: "formula"
|
||||
/** @description A constraint can be applied to the column which will be validated against when a row is saved. */
|
||||
constraints?: {
|
||||
/** @enum {string} */
|
||||
type?: "string" | "number" | "object" | "boolean"
|
||||
/** @description Defines whether the column is required or not. */
|
||||
presence?: boolean
|
||||
}
|
||||
/** @description The name of the column. */
|
||||
name?: string
|
||||
/** @description Defines whether the column is automatically generated. */
|
||||
autocolumn?: boolean
|
||||
/** @description Defines a Handlebars or JavaScript formula to use, note that Javascript formulas are expected to be provided in the base64 format. */
|
||||
formula?: string
|
||||
/**
|
||||
* @description Defines whether this is a static or dynamic formula.
|
||||
* @enum {string}
|
||||
*/
|
||||
formulaType?: "static" | "dynamic"
|
||||
}
|
||||
| {
|
||||
/**
|
||||
* @description Defines the type of the column, most explain themselves, a link column is a relationship.
|
||||
* @enum {string}
|
||||
*/
|
||||
type?:
|
||||
| "string"
|
||||
| "longform"
|
||||
| "options"
|
||||
| "number"
|
||||
| "boolean"
|
||||
| "array"
|
||||
| "datetime"
|
||||
| "attachment"
|
||||
| "link"
|
||||
| "formula"
|
||||
| "auto"
|
||||
| "json"
|
||||
| "internal"
|
||||
/** @description A constraint can be applied to the column which will be validated against when a row is saved. */
|
||||
constraints?: {
|
||||
/** @enum {string} */
|
||||
type?: "string" | "number" | "object" | "boolean"
|
||||
/** @description Defines whether the column is required or not. */
|
||||
presence?: boolean
|
||||
}
|
||||
/** @description The name of the column. */
|
||||
name?: string
|
||||
/** @description Defines whether the column is automatically generated. */
|
||||
autocolumn?: boolean
|
||||
}
|
||||
}
|
||||
/** @description The ID of the table. */
|
||||
_id: string
|
||||
}[]
|
||||
}
|
||||
/** @description The query body must contain the required parameters for the query, this depends on query type, setup and bindings. */
|
||||
executeQuery: { [key: string]: unknown }
|
||||
executeQueryOutput: {
|
||||
|
|
@ -855,6 +979,31 @@ export interface components {
|
|||
/** @description Whether the query has readable data. */
|
||||
readable?: boolean
|
||||
}
|
||||
querySearch: {
|
||||
data: {
|
||||
/** @description The ID of the query. */
|
||||
_id: string
|
||||
/** @description The ID of the data source the query belongs to. */
|
||||
datasourceId?: string
|
||||
/** @description The bindings which are required to perform this query. */
|
||||
parameters?: string[]
|
||||
/** @description The fields that are used to perform this query, e.g. the sql statement */
|
||||
fields?: { [key: string]: unknown }
|
||||
/**
|
||||
* @description The verb that describes this query.
|
||||
* @enum {undefined}
|
||||
*/
|
||||
queryVerb?: "create" | "read" | "update" | "delete"
|
||||
/** @description The name of the query. */
|
||||
name: string
|
||||
/** @description The schema of the data returned when the query is executed. */
|
||||
schema: { [key: string]: unknown }
|
||||
/** @description The JavaScript transformer function, applied after the query responds with data. */
|
||||
transformer?: string
|
||||
/** @description Whether the query has readable data. */
|
||||
readable?: boolean
|
||||
}[]
|
||||
}
|
||||
user: {
|
||||
/** @description The email address of the user, this must be unique. */
|
||||
email: string
|
||||
|
|
@ -917,6 +1066,39 @@ export interface components {
|
|||
_id: string
|
||||
}
|
||||
}
|
||||
userSearch: {
|
||||
data: {
|
||||
/** @description The email address of the user, this must be unique. */
|
||||
email: string
|
||||
/** @description The password of the user if using password based login - this will never be returned. This can be left out of subsequent requests (updates) and will be enriched back into the user structure. */
|
||||
password?: string
|
||||
/**
|
||||
* @description The status of the user, if they are active.
|
||||
* @enum {string}
|
||||
*/
|
||||
status?: "active"
|
||||
/** @description The first name of the user */
|
||||
firstName?: string
|
||||
/** @description The last name of the user */
|
||||
lastName?: string
|
||||
/** @description If set to true forces the user to reset their password on first login. */
|
||||
forceResetPassword?: boolean
|
||||
/** @description Describes if the user is a builder user or not. */
|
||||
builder?: {
|
||||
/** @description If set to true the user will be able to build any app in the system. */
|
||||
global?: boolean
|
||||
}
|
||||
/** @description Describes if the user is an admin user or not. */
|
||||
admin?: {
|
||||
/** @description If set to true the user will be able to administrate the system. */
|
||||
global?: boolean
|
||||
}
|
||||
/** @description Contains the roles of the user per app (assuming they are not a builder user). */
|
||||
roles: { [key: string]: string }
|
||||
/** @description The ID of the user. */
|
||||
_id: string
|
||||
}[]
|
||||
}
|
||||
nameSearch: {
|
||||
/** @description The name to be used when searching - this will be used in a case insensitive starts with match. */
|
||||
name: string
|
||||
|
|
|
|||
Loading…
Reference in New Issue