CodeMirror/budibase
1
0
Fork 0
mirror of synced 2024-08-12 16:41:26 +12:00
Code Issues Projects Releases Wiki Activity

Merge pull request #5140 from Budibase/fix/5117

Browse source 
Fix for query public API spec - was missing description of parameters property
This commit is contained in:
Martin McKeaveney 2022-03-29 10:16:13 +01:00 committed by GitHub
commit e9b382adc8
4 changed files with 82 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
packages/server/specs/openapi.json
View file

@ -1260,10 +1260,30 @@
]
},
"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",
"additionalProperties": {
"description": "Key value properties of any type, depending on the query output schema."
"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": {

24
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
additionalProperties:
description: Key value properties of any type, depending on the query output schema.
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:

32
packages/server/specs/resources/query.js
View file

@ -124,12 +124,34 @@ 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",
additionalProperties: {
description:
"Key value properties of any type, depending on the query output schema.",
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.",
},
},
},
},
}

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 }[];