MirrorSave
/
budibase
mirror of https://github.com/Budibase/budibase.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
budibase/packages/server/src/definitions/openapi.ts

1126 lines
42 KiB
TypeScript
Raw Normal View History

Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/**
* This file was auto-generated by openapi-typescript.
* Do not make direct changes to the file.
*/
export interface paths {
"/applications": {
post: {
parameters: {
header: {
/** The ID of the app which this request is targeting. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
"x-budibase-app-id": components["parameters"]["appId"]
}
}
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
responses: {
/** Returns the created application. */
200: {
content: {
Review comments and linting.
2022-03-01 23:37:42 +01:00
"application/json": components["schemas"]["applicationOutput"]
}
}
}
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
requestBody: {
content: {
Review comments and linting.
2022-03-01 23:37:42 +01:00
"application/json": components["schemas"]["application"]
}
}
}
}
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
"/applications/{appId}": {
get: {
parameters: {
path: {
/** The ID of the app which this request is targeting. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
appId: components["parameters"]["appIdUrl"]
}
}
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
responses: {
/** Returns the retrieved application. */
200: {
content: {
Review comments and linting.
2022-03-01 23:37:42 +01:00
"application/json": components["schemas"]["applicationOutput"]
}
}
}
}
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
put: {
parameters: {
path: {
/** The ID of the app which this request is targeting. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
appId: components["parameters"]["appIdUrl"]
}
}
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
responses: {
/** Returns the updated application. */
200: {
content: {
Review comments and linting.
2022-03-01 23:37:42 +01:00
"application/json": components["schemas"]["applicationOutput"]
}
}
}
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
requestBody: {
content: {
Review comments and linting.
2022-03-01 23:37:42 +01:00
"application/json": components["schemas"]["application"]
}
}
}
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
delete: {
parameters: {
path: {
/** The ID of the app which this request is targeting. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
appId: components["parameters"]["appIdUrl"]
}
}
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
responses: {
/** Returns the deleted application. */
200: {
content: {
Review comments and linting.
2022-03-01 23:37:42 +01:00
"application/json": components["schemas"]["applicationOutput"]
}
}
}
}
}
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
"/applications/search": {
/** Based on application properties (currently only name) search for applications. */
post: {
parameters: {
header: {
/** The ID of the app which this request is targeting. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
"x-budibase-app-id": components["parameters"]["appId"]
}
}
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
responses: {
/** Returns the applications that were found based on the search parameters. */
200: {
content: {
Quick fix for openAPI spec, improving the search spec.
2022-03-08 18:42:26 +01:00
"application/json": components["schemas"]["applicationSearch"]
Review comments and linting.
2022-03-01 23:37:42 +01:00
}
}
}
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
requestBody: {
content: {
Review comments and linting.
2022-03-01 23:37:42 +01:00
"application/json": components["schemas"]["nameSearch"]
}
}
}
}
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
"/queries/{queryId}": {
/** Queries which have been created within a Budibase app can be executed using this, */
post: {
parameters: {
path: {
/** The ID of the query which this request is targeting. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
queryId: components["parameters"]["queryId"]
}
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
header: {
/** The ID of the app which this request is targeting. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
"x-budibase-app-id": components["parameters"]["appId"]
}
}
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
responses: {
/** Returns the result of the query execution. */
200: {
content: {
Review comments and linting.
2022-03-01 23:37:42 +01:00
"application/json": components["schemas"]["executeQueryOutput"]
}
}
}
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
requestBody: {
content: {
Review comments and linting.
2022-03-01 23:37:42 +01:00
"application/json": components["schemas"]["executeQuery"]
}
}
}
}
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
"/queries/search": {
/** Based on query properties (currently only name) search for queries. */
post: {
parameters: {
header: {
/** The ID of the app which this request is targeting. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
"x-budibase-app-id": components["parameters"]["appId"]
}
}
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
responses: {
/** Returns the queries found based on the search parameters. */
200: {
content: {
Quick fix for openAPI spec, improving the search spec.
2022-03-08 18:42:26 +01:00
"application/json": components["schemas"]["querySearch"]
Review comments and linting.
2022-03-01 23:37:42 +01:00
}
}
}
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
requestBody: {
content: {
Review comments and linting.
2022-03-01 23:37:42 +01:00
"application/json": components["schemas"]["nameSearch"]
}
}
}
}
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
"/tables/{tableId}/rows": {
/** Creates a row within the specified table. */
post: {
parameters: {
path: {
/** The ID of the table which this request is targeting. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
tableId: components["parameters"]["tableId"]
}
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
header: {
/** The ID of the app which this request is targeting. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
"x-budibase-app-id": components["parameters"]["appId"]
}
}
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
responses: {
/** Returns the created row, including the ID which has been generated for it. This can be found in the Budibase portal, viewed under the developer information. */
200: {
content: {
Review comments and linting.
2022-03-01 23:37:42 +01:00
"application/json": components["schemas"]["rowOutput"]
}
}
}
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
requestBody: {
content: {
Review comments and linting.
2022-03-01 23:37:42 +01:00
"application/json": components["schemas"]["row"]
}
}
}
}
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
"/tables/{tableId}/rows/{rowId}": {
/** This gets a single row, it will be enriched with the full related rows, rather than the squashed "primaryDisplay" format returned by the search endpoint. */
get: {
parameters: {
path: {
/** The ID of the table which this request is targeting. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
tableId: components["parameters"]["tableId"]
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** The ID of the row which this request is targeting. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
rowId: components["parameters"]["rowId"]
}
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
header: {
/** The ID of the app which this request is targeting. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
"x-budibase-app-id": components["parameters"]["appId"]
}
}
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
responses: {
/** Returns the retrieved row. */
200: {
content: {
Review comments and linting.
2022-03-01 23:37:42 +01:00
"application/json": components["schemas"]["rowOutput"]
}
}
}
}
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** Updates a row within the specified table. */
put: {
parameters: {
path: {
/** The ID of the table which this request is targeting. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
tableId: components["parameters"]["tableId"]
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** The ID of the row which this request is targeting. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
rowId: components["parameters"]["rowId"]
}
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
header: {
/** The ID of the app which this request is targeting. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
"x-budibase-app-id": components["parameters"]["appId"]
}
}
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
responses: {
/** Returns the created row, including the ID which has been generated for it. */
200: {
content: {
Review comments and linting.
2022-03-01 23:37:42 +01:00
"application/json": components["schemas"]["rowOutput"]
}
}
}
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
requestBody: {
content: {
Review comments and linting.
2022-03-01 23:37:42 +01:00
"application/json": components["schemas"]["row"]
}
}
}
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** Deletes a row within the specified table. */
delete: {
parameters: {
path: {
/** The ID of the table which this request is targeting. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
tableId: components["parameters"]["tableId"]
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** The ID of the row which this request is targeting. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
rowId: components["parameters"]["rowId"]
}
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
header: {
/** The ID of the app which this request is targeting. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
"x-budibase-app-id": components["parameters"]["appId"]
}
}
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
responses: {
/** Returns the deleted row, including the ID which has been generated for it. */
200: {
content: {
Review comments and linting.
2022-03-01 23:37:42 +01:00
"application/json": components["schemas"]["rowOutput"]
}
}
}
}
}
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
"/tables/{tableId}/rows/search": {
post: {
parameters: {
path: {
/** The ID of the table which this request is targeting. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
tableId: components["parameters"]["tableId"]
}
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
header: {
/** The ID of the app which this request is targeting. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
"x-budibase-app-id": components["parameters"]["appId"]
}
}
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
responses: {
/** The response will contain an array of rows that match the search parameters. */
200: {
content: {
Review comments and linting.
2022-03-01 23:37:42 +01:00
"application/json": components["schemas"]["searchOutput"]
}
}
}
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
requestBody: {
content: {
"application/json": {
query: {
/**
* @description A map of field name to the string to search for, this will look for rows that have a value starting with the string value.
* @example [object Object]
*/
Review comments and linting.
2022-03-01 23:37:42 +01:00
string?: { [key: string]: string }
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** @description A fuzzy search, only supported by internal tables. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
fuzzy?: { [key: string]: unknown }
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/**
* @description Searches within a range, the format of this must be columnName -> [low, high].
* @example [object Object]
*/
Review comments and linting.
2022-03-01 23:37:42 +01:00
range?: { [key: string]: unknown }
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** @description Searches for rows that have a column value that is exactly the value set. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
equal?: { [key: string]: unknown }
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** @description Searches for any row which does not contain the specified column value. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
notEqual?: { [key: string]: unknown }
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/**
* @description Searches for rows which do not contain the specified column. The object should simply contain keys of the column names, these can map to any value.
* @example [object Object]
*/
Review comments and linting.
2022-03-01 23:37:42 +01:00
empty?: { [key: string]: unknown }
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** @description Searches for rows which have the specified column. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
notEmpty?: { [key: string]: unknown }
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** @description Searches for rows which have a column value that is any of the specified values. The format of this must be columnName -> [value1, value2]. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
oneOf?: { [key: string]: unknown }
}
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** @description Enables pagination, by default this is disabled. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
paginate?: boolean
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** @description If retrieving another page, the bookmark from the previous request must be supplied. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
bookmark?: string | number
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** @description The maximum number of rows to return, useful when paginating, for internal tables this will be limited to 1000, for SQL tables it will be 5000. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
limit?: number
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** @description A set of parameters describing the sort behaviour of the search. */
sort?: {
/**
* @description The order of the sort, by default this is ascending.
* @enum {string}
*/
Review comments and linting.
2022-03-01 23:37:42 +01:00
order?: "ascending" | "descending"
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** @description The name of the column by which the rows will be sorted. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
column?: string
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/**
* @description Defines whether the column should be treated as a string or as numbers when sorting.
* @enum {string}
*/
Review comments and linting.
2022-03-01 23:37:42 +01:00
type?: "string" | "number"
}
}
}
}
}
}
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
"/tables": {
/** Create a table, this could be internal or external. */
post: {
parameters: {
header: {
/** The ID of the app which this request is targeting. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
"x-budibase-app-id": components["parameters"]["appId"]
}
}
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
responses: {
/** Returns the created table, including the ID which has been generated for it. This can be internal or external data sources. */
200: {
content: {
Review comments and linting.
2022-03-01 23:37:42 +01:00
"application/json": components["schemas"]["tableOutput"]
}
}
}
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
requestBody: {
content: {
Review comments and linting.
2022-03-01 23:37:42 +01:00
"application/json": components["schemas"]["table"]
}
}
}
}
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
"/tables/{tableId}": {
/** Lookup a table, this could be internal or external. */
get: {
parameters: {
path: {
/** The ID of the table which this request is targeting. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
tableId: components["parameters"]["tableId"]
}
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
header: {
/** The ID of the app which this request is targeting. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
"x-budibase-app-id": components["parameters"]["appId"]
}
}
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
responses: {
/** Returns the retrieved table. */
200: {
content: {
Review comments and linting.
2022-03-01 23:37:42 +01:00
"application/json": components["schemas"]["tableOutput"]
}
}
}
}
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** Update a table, this could be internal or external. */
put: {
parameters: {
path: {
/** The ID of the table which this request is targeting. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
tableId: components["parameters"]["tableId"]
}
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
header: {
/** The ID of the app which this request is targeting. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
"x-budibase-app-id": components["parameters"]["appId"]
}
}
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
responses: {
/** Returns the updated table. */
200: {
content: {
Review comments and linting.
2022-03-01 23:37:42 +01:00
"application/json": components["schemas"]["tableOutput"]
}
}
}
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
requestBody: {
content: {
Review comments and linting.
2022-03-01 23:37:42 +01:00
"application/json": components["schemas"]["table"]
}
}
}
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** Delete a table, this could be internal or external. */
delete: {
parameters: {
path: {
/** The ID of the table which this request is targeting. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
tableId: components["parameters"]["tableId"]
}
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
header: {
/** The ID of the app which this request is targeting. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
"x-budibase-app-id": components["parameters"]["appId"]
}
}
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
responses: {
/** Returns the deleted table. */
200: {
content: {
Review comments and linting.
2022-03-01 23:37:42 +01:00
"application/json": components["schemas"]["tableOutput"]
}
}
}
}
}
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
"/tables/search": {
/** Based on table properties (currently only name) search for tables. This could be an internal or an external table. */
post: {
parameters: {
header: {
/** The ID of the app which this request is targeting. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
"x-budibase-app-id": components["parameters"]["appId"]
}
}
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
responses: {
/** Returns the found tables, based on the search parameters. */
200: {
content: {
Quick fix for openAPI spec, improving the search spec.
2022-03-08 18:42:26 +01:00
"application/json": components["schemas"]["tableSearch"]
Review comments and linting.
2022-03-01 23:37:42 +01:00
}
}
}
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
requestBody: {
content: {
Review comments and linting.
2022-03-01 23:37:42 +01:00
"application/json": components["schemas"]["nameSearch"]
}
}
}
}
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
"/users": {
post: {
responses: {
/** Returns the created user. */
200: {
content: {
Review comments and linting.
2022-03-01 23:37:42 +01:00
"application/json": components["schemas"]["userOutput"]
}
}
}
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
requestBody: {
content: {
Review comments and linting.
2022-03-01 23:37:42 +01:00
"application/json": components["schemas"]["user"]
}
}
}
}
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
"/users/{userId}": {
get: {
parameters: {
path: {
/** The ID of the user which this request is targeting. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
userId: components["parameters"]["userId"]
}
}
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
responses: {
/** Returns the retrieved user. */
200: {
content: {
Review comments and linting.
2022-03-01 23:37:42 +01:00
"application/json": components["schemas"]["userOutput"]
}
}
}
}
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
put: {
parameters: {
path: {
/** The ID of the user which this request is targeting. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
userId: components["parameters"]["userId"]
}
}
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
responses: {
/** Returns the updated user. */
200: {
content: {
Review comments and linting.
2022-03-01 23:37:42 +01:00
"application/json": components["schemas"]["userOutput"]
}
}
}
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
requestBody: {
content: {
Review comments and linting.
2022-03-01 23:37:42 +01:00
"application/json": components["schemas"]["user"]
}
}
}
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
delete: {
parameters: {
path: {
/** The ID of the user which this request is targeting. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
userId: components["parameters"]["userId"]
}
}
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
responses: {
/** Returns the deleted user. */
200: {
content: {
Review comments and linting.
2022-03-01 23:37:42 +01:00
"application/json": components["schemas"]["userOutput"]
}
}
}
}
}
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
"/users/search": {
/** Based on user properties (currently only name) search for users. */
post: {
responses: {
/** Returns the found users based on search parameters. */
200: {
content: {
Quick fix for openAPI spec, improving the search spec.
2022-03-08 18:42:26 +01:00
"application/json": components["schemas"]["userSearch"]
Review comments and linting.
2022-03-01 23:37:42 +01:00
}
}
}
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
requestBody: {
content: {
Review comments and linting.
2022-03-01 23:37:42 +01:00
"application/json": components["schemas"]["nameSearch"]
}
}
}
}
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
}
export interface components {
schemas: {
application: {
/** @description The name of the app. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
name: string
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** @description The URL by which the app is accessed, this must be URL encoded. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
url: string
}
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
applicationOutput: {
data: {
/** @description The name of the app. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
name: string
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** @description The URL by which the app is accessed, this must be URL encoded. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
url: string
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** @description The ID of the app. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
_id: string
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/**
* @description The status of the app, stating it if is the development or published version.
* @enum {string}
*/
Review comments and linting.
2022-03-01 23:37:42 +01:00
status: "development" | "published"
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** @description States when the app was created, will be constant. Stored in ISO format. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
createdAt: string
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** @description States the last time the app was updated - stored in ISO format. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
updatedAt: string
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** @description States the version of the Budibase client this app is currently based on. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
version: string
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** @description In a multi-tenant environment this will state the tenant this app is within. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
tenantId?: string
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** @description The user this app is currently being built by. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
lockedBy?: { [key: string]: unknown }
}
}
Quick fix for openAPI spec, improving the search spec.
2022-03-08 18:42:26 +01:00
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 }
}[]
}
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** @description The row to be created/updated, based on the table schema. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
row: { [key: string]: unknown }
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
searchOutput: {
/** @description An array of rows, these will each contain an _id field which can be used to update or delete them. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
data: { [key: string]: unknown }[]
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** @description If pagination in use, this should be provided. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
bookmark?: string | number
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** @description If pagination in use, this will determine if there is another page to fetch. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
hasNextPage?: boolean
}
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
rowOutput: {
/** @description The row to be created/updated, based on the table schema. */
data: {
/** @description The ID of the row. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
_id: string
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** @description The ID of the table this row comes from. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
tableId: string
} & { [key: string]: unknown }
}
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** @description The table to be created/updated. */
table: {
/** @description The name of the table. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
name: string
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** @description The name of the column which should be used in relationship tags when relating to this table. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
primaryDisplay?: string
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
schema: {
[key: string]:
| {
/**
* @description A relationship column.
* @enum {string}
*/
Review comments and linting.
2022-03-01 23:37:42 +01:00
type?: "link"
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** @description A constraint can be applied to the column which will be validated against when a row is saved. */
constraints?: {
/** @enum {string} */
Review comments and linting.
2022-03-01 23:37:42 +01:00
type?: "string" | "number" | "object" | "boolean"
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** @description Defines whether the column is required or not. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
presence?: boolean
}
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** @description The name of the column. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
name?: string
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** @description Defines whether the column is automatically generated. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
autocolumn?: boolean
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** @description The name of the column which a relationship column is related to in another table. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
fieldName?: string
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** @description The ID of the table which a relationship column is related to. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
tableId?: string
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/**
* @description Defines the type of relationship that this column will be used for.
* @enum {string}
*/
Review comments and linting.
2022-03-01 23:37:42 +01:00
relationshipType?: "one-to-many" | "many-to-one" | "many-to-many"
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** @description When using a SQL table that contains many to many relationships this defines the table the relationships are linked through. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
through?: string
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** @description When using a SQL table that contains a one to many relationship this defines the foreign key. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
foreignKey?: string
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** @description When using a SQL table that utilises a through table, this defines the primary key in the through table for this table. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
throughFrom?: string
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** @description When using a SQL table that utilises a through table, this defines the primary key in the through table for the related table. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
throughTo?: string
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
}
| {
/**
* @description A formula column.
* @enum {string}
*/
Review comments and linting.
2022-03-01 23:37:42 +01:00
type?: "formula"
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** @description A constraint can be applied to the column which will be validated against when a row is saved. */
constraints?: {
/** @enum {string} */
Review comments and linting.
2022-03-01 23:37:42 +01:00
type?: "string" | "number" | "object" | "boolean"
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** @description Defines whether the column is required or not. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
presence?: boolean
}
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** @description The name of the column. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
name?: string
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** @description Defines whether the column is automatically generated. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
autocolumn?: boolean
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** @description Defines a Handlebars or JavaScript formula to use, note that Javascript formulas are expected to be provided in the base64 format. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
formula?: string
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/**
* @description Defines whether this is a static or dynamic formula.
* @enum {string}
*/
Review comments and linting.
2022-03-01 23:37:42 +01:00
formulaType?: "static" | "dynamic"
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
}
| {
/**
* @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"
Review comments and linting.
2022-03-01 23:37:42 +01:00
| "internal"
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** @description A constraint can be applied to the column which will be validated against when a row is saved. */
constraints?: {
/** @enum {string} */
Review comments and linting.
2022-03-01 23:37:42 +01:00
type?: "string" | "number" | "object" | "boolean"
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** @description Defines whether the column is required or not. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
presence?: boolean
}
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** @description The name of the column. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
name?: string
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** @description Defines whether the column is automatically generated. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
autocolumn?: boolean
}
}
}
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
tableOutput: {
/** @description The table to be created/updated. */
data: {
/** @description The name of the table. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
name: string
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** @description The name of the column which should be used in relationship tags when relating to this table. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
primaryDisplay?: string
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
schema: {
[key: string]:
| {
/**
* @description A relationship column.
* @enum {string}
*/
Review comments and linting.
2022-03-01 23:37:42 +01:00
type?: "link"
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** @description A constraint can be applied to the column which will be validated against when a row is saved. */
constraints?: {
/** @enum {string} */
Review comments and linting.
2022-03-01 23:37:42 +01:00
type?: "string" | "number" | "object" | "boolean"
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** @description Defines whether the column is required or not. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
presence?: boolean
}
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** @description The name of the column. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
name?: string
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** @description Defines whether the column is automatically generated. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
autocolumn?: boolean
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** @description The name of the column which a relationship column is related to in another table. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
fieldName?: string
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** @description The ID of the table which a relationship column is related to. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
tableId?: string
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/**
* @description Defines the type of relationship that this column will be used for.
* @enum {string}
*/
relationshipType?:
| "one-to-many"
| "many-to-one"
Review comments and linting.
2022-03-01 23:37:42 +01:00
| "many-to-many"
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** @description When using a SQL table that contains many to many relationships this defines the table the relationships are linked through. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
through?: string
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** @description When using a SQL table that contains a one to many relationship this defines the foreign key. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
foreignKey?: string
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** @description When using a SQL table that utilises a through table, this defines the primary key in the through table for this table. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
throughFrom?: string
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** @description When using a SQL table that utilises a through table, this defines the primary key in the through table for the related table. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
throughTo?: string
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
}
| {
/**
* @description A formula column.
* @enum {string}
*/
Review comments and linting.
2022-03-01 23:37:42 +01:00
type?: "formula"
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** @description A constraint can be applied to the column which will be validated against when a row is saved. */
constraints?: {
/** @enum {string} */
Review comments and linting.
2022-03-01 23:37:42 +01:00
type?: "string" | "number" | "object" | "boolean"
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** @description Defines whether the column is required or not. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
presence?: boolean
}
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** @description The name of the column. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
name?: string
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** @description Defines whether the column is automatically generated. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
autocolumn?: boolean
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** @description Defines a Handlebars or JavaScript formula to use, note that Javascript formulas are expected to be provided in the base64 format. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
formula?: string
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/**
* @description Defines whether this is a static or dynamic formula.
* @enum {string}
*/
Review comments and linting.
2022-03-01 23:37:42 +01:00
formulaType?: "static" | "dynamic"
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
}
| {
/**
* @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"
Review comments and linting.
2022-03-01 23:37:42 +01:00
| "internal"
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** @description A constraint can be applied to the column which will be validated against when a row is saved. */
constraints?: {
/** @enum {string} */
Review comments and linting.
2022-03-01 23:37:42 +01:00
type?: "string" | "number" | "object" | "boolean"
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** @description Defines whether the column is required or not. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
presence?: boolean
}
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** @description The name of the column. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
name?: string
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** @description Defines whether the column is automatically generated. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
autocolumn?: boolean
}
}
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** @description The ID of the table. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
_id: string
}
}
Quick fix for openAPI spec, improving the search spec.
2022-03-08 18:42:26 +01:00
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
}[]
}
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** @description The query body must contain the required parameters for the query, this depends on query type, setup and bindings. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
executeQuery: { [key: string]: unknown }
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
executeQueryOutput: {
/** @description The data response from the query. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
data: { [key: string]: unknown }[]
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** @description Extra information that is not part of the main data, e.g. headers. */
extra?: {
/** @description If carrying out a REST request, this will contain the response headers. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
headers?: { [key: string]: unknown }
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** @description The raw query response, as a string. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
raw?: string
}
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** @description If pagination is supported, this will contain the bookmark/anchor information for it. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
pagination?: { [key: string]: unknown }
}
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
query: {
/** @description The ID of the query. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
_id: string
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** @description The ID of the data source the query belongs to. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
datasourceId?: string
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** @description The bindings which are required to perform this query. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
parameters?: string[]
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** @description The fields that are used to perform this query, e.g. the sql statement */
Review comments and linting.
2022-03-01 23:37:42 +01:00
fields?: { [key: string]: unknown }
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/**
* @description The verb that describes this query.
* @enum {undefined}
*/
Review comments and linting.
2022-03-01 23:37:42 +01:00
queryVerb?: "create" | "read" | "update" | "delete"
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** @description The name of the query. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
name: string
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** @description The schema of the data returned when the query is executed. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
schema: { [key: string]: unknown }
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** @description The JavaScript transformer function, applied after the query responds with data. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
transformer?: string
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** @description Whether the query has readable data. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
readable?: boolean
}
Quick fix for openAPI spec, improving the search spec.
2022-03-08 18:42:26 +01:00
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
}[]
}
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
user: {
/** @description The email address of the user, this must be unique. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
email: string
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** @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. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
password?: string
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/**
* @description The status of the user, if they are active.
* @enum {string}
*/
Review comments and linting.
2022-03-01 23:37:42 +01:00
status?: "active"
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** @description The first name of the user */
Review comments and linting.
2022-03-01 23:37:42 +01:00
firstName?: string
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** @description The last name of the user */
Review comments and linting.
2022-03-01 23:37:42 +01:00
lastName?: string
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** @description If set to true forces the user to reset their password on first login. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
forceResetPassword?: boolean
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** @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. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
global?: boolean
}
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** @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. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
global?: boolean
}
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** @description Contains the roles of the user per app (assuming they are not a builder user). */
Review comments and linting.
2022-03-01 23:37:42 +01:00
roles: { [key: string]: string }
}
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
userOutput: {
data: {
/** @description The email address of the user, this must be unique. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
email: string
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** @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. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
password?: string
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/**
* @description The status of the user, if they are active.
* @enum {string}
*/
Review comments and linting.
2022-03-01 23:37:42 +01:00
status?: "active"
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** @description The first name of the user */
Review comments and linting.
2022-03-01 23:37:42 +01:00
firstName?: string
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** @description The last name of the user */
Review comments and linting.
2022-03-01 23:37:42 +01:00
lastName?: string
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** @description If set to true forces the user to reset their password on first login. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
forceResetPassword?: boolean
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** @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. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
global?: boolean
}
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** @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. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
global?: boolean
}
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** @description Contains the roles of the user per app (assuming they are not a builder user). */
Review comments and linting.
2022-03-01 23:37:42 +01:00
roles: { [key: string]: string }
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** @description The ID of the user. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
_id: string
}
}
Quick fix for openAPI spec, improving the search spec.
2022-03-08 18:42:26 +01:00
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
}[]
}
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
nameSearch: {
/** @description The name to be used when searching - this will be used in a case insensitive starts with match. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
name: string
}
}
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
parameters: {
/** @description The ID of the table which this request is targeting. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
tableId: string
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** @description The ID of the row which this request is targeting. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
rowId: string
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** @description The ID of the app which this request is targeting. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
appId: string
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** @description The ID of the app which this request is targeting. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
appIdUrl: string
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** @description The ID of the query which this request is targeting. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
queryId: string
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
/** @description The ID of the user which this request is targeting. */
Review comments and linting.
2022-03-01 23:37:42 +01:00
userId: string
}
Adding new generation technique, converting openAPI spec to typescript definitions, which are then applied in mapping output middlewares to make sure that the structures of the response are fully respected.
2022-03-01 19:35:08 +01:00
}
export interface operations {}
export interface external {}