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

Fix for #5117 - raised a point that the docs didn't describe where to put properties for a query when running through the public API - fixing the spec.

This commit is contained in:
mike12345567 2022-03-28 18:33:54 +01:00
parent 9890b45d71
commit db0b096c0a
4 changed files with 82 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -1260,12 +1260,32 @@
]
},
"executeQuery": {
"description": "The query body must contain the required parameters for the query, this depends on query type, setup and bindings.",
"description": "The parameters required for executing a query.",
"type": "object",
"properties": {
"parameters": {
"type": "object",
"description": "This contains the required parameters for the query, this depends on query type, setup and bindings.",
"additionalProperties": {
"description": "Key value properties of any type, depending on the query output schema."
}
},
"pagination": {
"type": "object",
"description": "For supported query types (currently on REST) pagination can be performed using these properties.",
"properties": {
"page": {
"type": "string",
"description": "The page which has been returned from a previous query."
},
"limit": {
"type": "number",
"description": "The number of rows to return per page."
}
}
}
}
},
"executeQueryOutput": {
"type": "object",
"properties": {

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

@ -951,11 +951,27 @@ components:
required:
- data
executeQuery:
description: The query body must contain the required parameters for the query,
this depends on query type, setup and bindings.
description: The parameters required for executing a query.
type: object
properties:
parameters:
type: object
description: This contains the required parameters for the query, this depends
on query type, setup and bindings.
additionalProperties:
description: Key value properties of any type, depending on the query output schema.
description: Key value properties of any type, depending on the query output
schema.
pagination:
type: object
description: For supported query types (currently on REST) pagination can be
performed using these properties.
properties:
page:
type: string
description: The page which has been returned from a previous query.
limit:
type: number
description: The number of rows to return per page.
executeQueryOutput:
type: object
properties:

26
packages/server/specs/resources/query.js
View File

@ -124,13 +124,35 @@ const querySchema = object(
)
const executeQuerySchema = {
description:
"The query body must contain the required parameters for the query, this depends on query type, setup and bindings.",
description: "The parameters required for executing a query.",
type: "object",
properties: {
parameters: {
type: "object",
description:
"This contains the required parameters for the query, this depends on query type, setup and bindings.",
additionalProperties: {
description:
"Key value properties of any type, depending on the query output schema.",
},
},
pagination: {
type: "object",
description:
"For supported query types (currently on REST) pagination can be performed using these properties.",
properties: {
page: {
type: "string",
description:
"The page which has been returned from a previous query.",
},
limit: {
type: "number",
description: "The number of rows to return per page.",
},
},
},
},
}
const executeQueryOutputSchema = object(

14
packages/server/src/definitions/openapi.ts
View File

@ -935,8 +935,18 @@ export interface components {
_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 };
/** @description The parameters required for executing a query. */
executeQuery: {
/** @description This contains the required parameters for the query, this depends on query type, setup and bindings. */
parameters?: { [key: string]: unknown };
/** @description For supported query types (currently on REST) pagination can be performed using these properties. */
pagination?: {
/** @description The page which has been returned from a previous query. */
page?: string;
/** @description The number of rows to return per page. */
limit?: number;
};
};
executeQueryOutput: {
/** @description The data response from the query. */
data: { [key: string]: unknown }[];