tsai
/
budibase
mirror of https://github.com/Budibase/budibase.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

Updating table schema and adding query endpoints.

pull/4732/head
mike12345567 4 years ago
parent
97337db4ee
commit
23ccb924f7
6 changed files with 541 additions and 100 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. 268
      packages/server/specs/openapi.json
  2. 209
      packages/server/specs/openapi.yaml
  3. 125
      packages/server/specs/schemas.js
  4. 7
      packages/server/src/api/controllers/public/queries.js
  5. 21
      packages/server/src/api/routes/public/queries.js
  6. 11
      packages/server/src/api/routes/public/tables.js

268
packages/server/specs/openapi.json
View File

@ -183,31 +183,187 @@
"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": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"string",
"longform",
"options",
"number",
"boolean",
"array",
"datetime",
"attachment",
"link",
"formula",
"auto",
"json",
"internal"
]
"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."
}
}
}
}
]
}
}
}
@ -219,6 +375,22 @@
}
],
"paths": {
"/queries/search": {
"post": {
"summary": "Search for a query based on its name.",
"tags": [
"queries"
]
}
},
"/queries/{queryId}": {
"post": {
"summary": "Execute a query and retrieve its response.",
"tags": [
"queries"
]
}
},
"/tables/{tableId}/rows/search": {
"post": {
"summary": "Used to search for rows within a table.",
@ -573,7 +745,7 @@
"properties": {
"name": {
"type": "string",
"description": "The name of the table, this should be an exact match (ignoring case)."
"description": "The name of the table, this is a case insensitive search using the provided name as a starts with search."
}
}
}
@ -644,9 +816,11 @@
}
}
}
},
"get": {
"summary": "Get all the tables, internal and external within an app.",
}
},
"/tables/:tableId": {
"put": {
"summary": "Update the specified table. This can be for internal or external tables.",
"tags": [
"tables"
],
@ -658,9 +832,23 @@
"$ref": "#/components/parameters/appId"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/table"
},
"examples": {
"table": {
"$ref": "#/components/examples/table"
}
}
}
}
},
"responses": {
"200": {
"description": "Returns all of the tables which were found.",
"description": "Returns the updated table.",
"content": {
"application/json": {
"schema": {
@ -677,9 +865,9 @@
}
}
},
"/tables/:tableId": {
"put": {
"summary": "Update the specified table. This can be for internal or external tables.",
"/tables/{tableId}": {
"get": {
"summary": "Get a single table by its ID, internal and external within an app.",
"tags": [
"tables"
],
@ -691,23 +879,9 @@
"$ref": "#/components/parameters/appId"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/table"
},
"examples": {
"table": {
"$ref": "#/components/examples/table"
}
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated table.",
"description": "Returns the table that was found.",
"content": {
"application/json": {
"schema": {
@ -722,9 +896,7 @@
}
}
}
}
},
"/tables/{tableId}": {
},
"delete": {
"summary": "Delete a single table and all of its data.",
"tags": [

209
packages/server/specs/openapi.yaml
View File

@ -123,30 +123,163 @@ components:
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:
type: object
properties:
type:
type: string
enum:
- string
- longform
- options
- number
- boolean
- array
- datetime
- attachment
- link
- formula
- auto
- json
- internal
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.
security:
- ApiKeyAuth: []
paths:
/queries/search:
post:
summary: Search for a query based on its name.
tags:
- queries
"/queries/{queryId}":
post:
summary: Execute a query and retrieve its response.
tags:
- queries
"/tables/{tableId}/rows/search":
post:
summary: Used to search for rows within a table.
@ -380,8 +513,8 @@ paths:
properties:
name:
type: string
description: The name of the table, this should be an exact match (ignoring
case).
description: The name of the table, this is a case insensitive search using the
provided name as a starts with search.
responses:
"200":
description: Returns the found tables, based on the search parameters.
@ -420,16 +553,25 @@ paths:
examples:
table:
$ref: "#/components/examples/table"
get:
summary: Get all the tables, internal and external within an app.
/tables/:tableId:
put:
summary: Update the specified table. This can be for internal or external tables.
tags:
- tables
parameters:
- $ref: "#/components/parameters/tableId"
- $ref: "#/components/parameters/appId"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/table"
examples:
table:
$ref: "#/components/examples/table"
responses:
"200":
description: Returns all of the tables which were found.
description: Returns the updated table.
content:
application/json:
schema:
@ -437,25 +579,17 @@ paths:
examples:
table:
$ref: "#/components/examples/row"
/tables/:tableId:
put:
summary: Update the specified table. This can be for internal or external tables.
"/tables/{tableId}":
get:
summary: Get a single table by its ID, internal and external within an app.
tags:
- tables
parameters:
- $ref: "#/components/parameters/tableId"
- $ref: "#/components/parameters/appId"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/table"
examples:
table:
$ref: "#/components/examples/table"
responses:
"200":
description: Returns the updated table.
description: Returns the table that was found.
content:
application/json:
schema:
@ -463,7 +597,6 @@ paths:
examples:
table:
$ref: "#/components/examples/row"
"/tables/{tableId}":
delete:
summary: Delete a single table and all of its data.
tags:

125
packages/server/specs/schemas.js
View File

@ -1,4 +1,8 @@
const { FieldTypes } = require("../src/constants")
const {
FieldTypes,
RelationshipTypes,
FormulaTypes,
} = require("../src/constants")
exports.row = {
description: "The row to be created/updated, based on the table schema.",
@ -14,6 +18,38 @@ exports.row = {
},
}
const baseColumnDef = {
type: {
type: "string",
enum: Object.values(FieldTypes),
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.",
},
}
exports.table = {
description: "The table to be created/updated.",
type: "object",
@ -22,17 +58,88 @@ exports.table = {
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: {
type: "object",
properties: {
type: {
type: "string",
enum: Object.values(FieldTypes),
oneOf: [
// relationship
{
type: "object",
properties: {
...baseColumnDef,
type: {
type: "string",
enum: [FieldTypes.LINK],
description: "A relationship column.",
},
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: Object.values(RelationshipTypes),
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: {
...baseColumnDef,
type: {
type: "string",
enum: [FieldTypes.FORMULA],
description: "A formula column.",
},
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: Object.values(FormulaTypes),
description:
"Defines whether this is a static or dynamic formula.",
},
},
},
{
type: "object",
properties: baseColumnDef,
},
],
},
},
}

7
packages/server/src/api/controllers/public/queries.js
View File

@ -0,0 +1,7 @@
exports.search = () => {
}
exports.execute = () => {
}

21
packages/server/src/api/routes/public/queries.js
View File

@ -1,5 +1,26 @@
const Router = require("@koa/router")
const controller = require("../../controllers/public/queries")
const router = Router()
/**
* @openapi
* /queries/search:
* post:
* summary: Search for a query based on its name.
* tags:
* - queries
*/
router.post("/queries/search", controller.search)
/**
* @openapi
* /queries/{queryId}:
* post:
* summary: Execute a query and retrieve its response.
* tags:
* - queries
*/
router.post("/queries/:queryId", controller.execute)
module.exports = router

11
packages/server/src/api/routes/public/tables.js
View File

@ -20,7 +20,8 @@ const router = Router()
* properties:
* name:
* type: string
* description: The name of the table, this should be an exact match (ignoring case).
* description: The name of the table, this is a case insensitive search using the provided
* name as a starts with search.
* responses:
* 200:
* description: Returns the found tables, based on the search parameters.
@ -100,9 +101,9 @@ router.put("/tables/:tableId", controller.update)
/**
* @openapi
* /tables:
* /tables/{tableId}:
* get:
* summary: Get all the tables, internal and external within an app.
* summary: Get a single table by its ID, internal and external within an app.
* tags:
* - tables
* parameters:
@ -110,7 +111,7 @@ router.put("/tables/:tableId", controller.update)
* - $ref: '#/components/parameters/appId'
* responses:
* 200:
* description: Returns all of the tables which were found.
* description: Returns the table that was found.
* content:
* application/json:
* schema:
@ -119,7 +120,7 @@ router.put("/tables/:tableId", controller.update)
* table:
* $ref: '#/components/examples/row'
*/
router.get("/tables", controller.singleRead)
router.get("/tables/:tableId", controller.singleRead)
/**
* @openapi

Write Preview
Loading…
Cancel
Save