CodeMirror/budibase
1
0
Fork 0
mirror of synced 2024-06-28 11:00:55 +12:00
Code Issues Projects Releases Wiki Activity

Update public API operation IDs to be shorter

Browse source
This commit is contained in:
Andrew Kingston 2022-09-21 19:11:47 +01:00
parent 448c62e1d9
commit 2ccdf4b10b
9 changed files with 114 additions and 463 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -1792,7 +1792,7 @@
"paths": { "paths": {
"/applications": { "/applications": {
"post": { "post": {
"operationId": "createApplication", "operationId": "create",
"summary": "Create an application", "summary": "Create an application",
"tags": [ "tags": [
"applications" "applications"
@ -1833,7 +1833,7 @@
}, },
"/applications/{appId}": { "/applications/{appId}": {
"put": { "put": {
"operationId": "updateApplication", "operationId": "update",
"summary": "Update an application", "summary": "Update an application",
"tags": [ "tags": [
"applications" "applications"
@ -1872,7 +1872,7 @@
} }
}, },
"delete": { "delete": {
"operationId": "deleteApplication", "operationId": "delete",
"summary": "Delete an application", "summary": "Delete an application",
"tags": [ "tags": [
"applications" "applications"
@ -1901,7 +1901,7 @@
} }
}, },
"get": { "get": {
"operationId": "getApplicationById", "operationId": "getById",
"summary": "Retrieve an application", "summary": "Retrieve an application",
"tags": [ "tags": [
"applications" "applications"
@ -1932,7 +1932,7 @@
}, },
"/applications/search": { "/applications/search": {
"post": { "post": {
"operationId": "searchApplications", "operationId": "search",
"summary": "Search for applications", "summary": "Search for applications",
"description": "Based on application properties (currently only name) search for applications.", "description": "Based on application properties (currently only name) search for applications.",
"tags": [ "tags": [
@ -1969,7 +1969,7 @@
}, },
"/queries/{queryId}": { "/queries/{queryId}": {
"post": { "post": {
"operationId": "executeQuery", "operationId": "execute",
"summary": "Execute a query", "summary": "Execute a query",
"description": "Queries which have been created within a Budibase app can be executed using this,", "description": "Queries which have been created within a Budibase app can be executed using this,",
"tags": [ "tags": [
@ -2017,7 +2017,7 @@
}, },
"/queries/search": { "/queries/search": {
"post": { "post": {
"operationId": "searchQueries", "operationId": "search",
"summary": "Search for queries", "summary": "Search for queries",
"description": "Based on query properties (currently only name) search for queries.", "description": "Based on query properties (currently only name) search for queries.",
"tags": [ "tags": [
@ -2059,7 +2059,7 @@
}, },
"/tables/{tableId}/rows": { "/tables/{tableId}/rows": {
"post": { "post": {
"operationId": "createRow", "operationId": "create",
"summary": "Create a row", "summary": "Create a row",
"description": "Creates a row within the specified table.", "description": "Creates a row within the specified table.",
"tags": [ "tags": [
@ -2109,7 +2109,7 @@
}, },
"/tables/{tableId}/rows/{rowId}": { "/tables/{tableId}/rows/{rowId}": {
"put": { "put": {
"operationId": "updateRow", "operationId": "update",
"summary": "Update a row", "summary": "Update a row",
"description": "Updates a row within the specified table.", "description": "Updates a row within the specified table.",
"tags": [ "tags": [
@ -2160,7 +2160,7 @@
} }
}, },
"delete": { "delete": {
"operationId": "deleteRow", "operationId": "delete",
"summary": "Delete a row", "summary": "Delete a row",
"description": "Deletes a row within the specified table.", "description": "Deletes a row within the specified table.",
"tags": [ "tags": [
@ -2196,7 +2196,7 @@
} }
}, },
"get": { "get": {
"operationId": "getRowById", "operationId": "getById",
"summary": "Retrieve a row", "summary": "Retrieve a row",
"description": "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.", "description": "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.",
"tags": [ "tags": [
@ -2234,7 +2234,7 @@
}, },
"/tables/{tableId}/rows/search": { "/tables/{tableId}/rows/search": {
"post": { "post": {
"operationId": "searchRows", "operationId": "search",
"summary": "Search for rows", "summary": "Search for rows",
"tags": [ "tags": [
"rows" "rows"
@ -2278,7 +2278,7 @@
}, },
"/tables": { "/tables": {
"post": { "post": {
"operationId": "createTable", "operationId": "create",
"summary": "Create a table", "summary": "Create a table",
"description": "Create a table, this could be internal or external.", "description": "Create a table, this could be internal or external.",
"tags": [ "tags": [
@ -2324,7 +2324,7 @@
}, },
"/tables/{tableId}": { "/tables/{tableId}": {
"put": { "put": {
"operationId": "updateTable", "operationId": "update",
"summary": "Update a table", "summary": "Update a table",
"description": "Update a table, this could be internal or external.", "description": "Update a table, this could be internal or external.",
"tags": [ "tags": [
@ -2371,7 +2371,7 @@
} }
}, },
"delete": { "delete": {
"operationId": "deleteTable", "operationId": "delete",
"summary": "Delete a table", "summary": "Delete a table",
"description": "Delete a table, this could be internal or external.", "description": "Delete a table, this could be internal or external.",
"tags": [ "tags": [
@ -2404,7 +2404,7 @@
} }
}, },
"get": { "get": {
"operationId": "getTableById", "operationId": "getById",
"summary": "Retrieve a table", "summary": "Retrieve a table",
"description": "Lookup a table, this could be internal or external.", "description": "Lookup a table, this could be internal or external.",
"tags": [ "tags": [
@ -2439,7 +2439,7 @@
}, },
"/tables/search": { "/tables/search": {
"post": { "post": {
"operationId": "searchTables", "operationId": "search",
"summary": "Search for tables", "summary": "Search for tables",
"description": "Based on table properties (currently only name) search for tables. This could be an internal or an external table.", "description": "Based on table properties (currently only name) search for tables. This could be an internal or an external table.",
"tags": [ "tags": [
@ -2481,7 +2481,7 @@
}, },
"/users": { "/users": {
"post": { "post": {
"operationId": "createUser", "operationId": "create",
"summary": "Create a user", "summary": "Create a user",
"tags": [ "tags": [
"users" "users"
@ -2517,7 +2517,7 @@
}, },
"/users/{userId}": { "/users/{userId}": {
"put": { "put": {
"operationId": "updateUser", "operationId": "update",
"summary": "Update a user", "summary": "Update a user",
"tags": [ "tags": [
"users" "users"
@ -2556,7 +2556,7 @@
} }
}, },
"delete": { "delete": {
"operationId": "deleteUser", "operationId": "delete",
"summary": "Delete a user", "summary": "Delete a user",
"tags": [ "tags": [
"users" "users"
@ -2585,7 +2585,7 @@
} }
}, },
"get": { "get": {
"operationId": "getUserById", "operationId": "getById",
"summary": "Retrieve a user", "summary": "Retrieve a user",
"tags": [ "tags": [
"users" "users"
@ -2616,7 +2616,7 @@
}, },
"/users/search": { "/users/search": {
"post": { "post": {
"operationId": "searchUsers", "operationId": "search",
"summary": "Search for users", "summary": "Search for users",
"description": "Based on user properties (currently only name) search for users.", "description": "Based on user properties (currently only name) search for users.",
"tags": [ "tags": [

44
packages/server/specs/openapi.yaml
View file

@ -1370,7 +1370,7 @@ security:
paths: paths:
/applications: /applications:
post: post:
operationId: createApplication operationId: create
summary: Create an application summary: Create an application
tags: tags:
- applications - applications
@ -1394,7 +1394,7 @@ paths:
$ref: "#/components/examples/application" $ref: "#/components/examples/application"
"/applications/{appId}": "/applications/{appId}":
put: put:
operationId: updateApplication operationId: update
summary: Update an application summary: Update an application
tags: tags:
- applications - applications
@ -1417,7 +1417,7 @@ paths:
application: application:
$ref: "#/components/examples/application" $ref: "#/components/examples/application"
delete: delete:
operationId: deleteApplication operationId: delete
summary: Delete an application summary: Delete an application
tags: tags:
- applications - applications
@ -1434,7 +1434,7 @@ paths:
application: application:
$ref: "#/components/examples/application" $ref: "#/components/examples/application"
get: get:
operationId: getApplicationById operationId: getById
summary: Retrieve an application summary: Retrieve an application
tags: tags:
- applications - applications
@ -1452,7 +1452,7 @@ paths:
$ref: "#/components/examples/application" $ref: "#/components/examples/application"
/applications/search: /applications/search:
post: post:
operationId: searchApplications operationId: search
summary: Search for applications summary: Search for applications
description: Based on application properties (currently only name) search for description: Based on application properties (currently only name) search for
applications. applications.
@ -1477,7 +1477,7 @@ paths:
$ref: "#/components/examples/applications" $ref: "#/components/examples/applications"
"/queries/{queryId}": "/queries/{queryId}":
post: post:
operationId: executeQuery operationId: execute
summary: Execute a query summary: Execute a query
description: Queries which have been created within a Budibase app can be description: Queries which have been created within a Budibase app can be
executed using this, executed using this,
@ -1506,7 +1506,7 @@ paths:
$ref: "#/components/examples/sqlResponse" $ref: "#/components/examples/sqlResponse"
/queries/search: /queries/search:
post: post:
operationId: searchQueries operationId: search
summary: Search for queries summary: Search for queries
description: Based on query properties (currently only name) search for queries. description: Based on query properties (currently only name) search for queries.
tags: tags:
@ -1531,7 +1531,7 @@ paths:
$ref: "#/components/examples/queries" $ref: "#/components/examples/queries"
"/tables/{tableId}/rows": "/tables/{tableId}/rows":
post: post:
operationId: createRow operationId: create
summary: Create a row summary: Create a row
description: Creates a row within the specified table. description: Creates a row within the specified table.
tags: tags:
@ -1562,7 +1562,7 @@ paths:
$ref: "#/components/examples/row" $ref: "#/components/examples/row"
"/tables/{tableId}/rows/{rowId}": "/tables/{tableId}/rows/{rowId}":
put: put:
operationId: updateRow operationId: update
summary: Update a row summary: Update a row
description: Updates a row within the specified table. description: Updates a row within the specified table.
tags: tags:
@ -1592,7 +1592,7 @@ paths:
row: row:
$ref: "#/components/examples/row" $ref: "#/components/examples/row"
delete: delete:
operationId: deleteRow operationId: delete
summary: Delete a row summary: Delete a row
description: Deletes a row within the specified table. description: Deletes a row within the specified table.
tags: tags:
@ -1613,7 +1613,7 @@ paths:
row: row:
$ref: "#/components/examples/row" $ref: "#/components/examples/row"
get: get:
operationId: getRowById operationId: getById
summary: Retrieve a row summary: Retrieve a row
description: This gets a single row, it will be enriched with the full related description: This gets a single row, it will be enriched with the full related
rows, rather than the squashed "primaryDisplay" format returned by the rows, rather than the squashed "primaryDisplay" format returned by the
@ -1636,7 +1636,7 @@ paths:
$ref: "#/components/examples/enrichedRow" $ref: "#/components/examples/enrichedRow"
"/tables/{tableId}/rows/search": "/tables/{tableId}/rows/search":
post: post:
operationId: searchRows operationId: search
summary: Search for rows summary: Search for rows
tags: tags:
- rows - rows
@ -1662,7 +1662,7 @@ paths:
$ref: "#/components/examples/rows" $ref: "#/components/examples/rows"
/tables: /tables:
post: post:
operationId: createTable operationId: create
summary: Create a table summary: Create a table
description: Create a table, this could be internal or external. description: Create a table, this could be internal or external.
tags: tags:
@ -1690,7 +1690,7 @@ paths:
$ref: "#/components/examples/table" $ref: "#/components/examples/table"
"/tables/{tableId}": "/tables/{tableId}":
put: put:
operationId: updateTable operationId: update
summary: Update a table summary: Update a table
description: Update a table, this could be internal or external. description: Update a table, this could be internal or external.
tags: tags:
@ -1717,7 +1717,7 @@ paths:
table: table:
$ref: "#/components/examples/table" $ref: "#/components/examples/table"
delete: delete:
operationId: deleteTable operationId: delete
summary: Delete a table summary: Delete a table
description: Delete a table, this could be internal or external. description: Delete a table, this could be internal or external.
tags: tags:
@ -1736,7 +1736,7 @@ paths:
table: table:
$ref: "#/components/examples/table" $ref: "#/components/examples/table"
get: get:
operationId: getTableById operationId: getById
summary: Retrieve a table summary: Retrieve a table
description: Lookup a table, this could be internal or external. description: Lookup a table, this could be internal or external.
tags: tags:
@ -1756,7 +1756,7 @@ paths:
$ref: "#/components/examples/table" $ref: "#/components/examples/table"
/tables/search: /tables/search:
post: post:
operationId: searchTables operationId: search
summary: Search for tables summary: Search for tables
description: Based on table properties (currently only name) search for tables. description: Based on table properties (currently only name) search for tables.
This could be an internal or an external table. This could be an internal or an external table.
@ -1782,7 +1782,7 @@ paths:
$ref: "#/components/examples/tables" $ref: "#/components/examples/tables"
/users: /users:
post: post:
operationId: createUser operationId: create
summary: Create a user summary: Create a user
tags: tags:
- users - users
@ -1804,7 +1804,7 @@ paths:
$ref: "#/components/examples/user" $ref: "#/components/examples/user"
"/users/{userId}": "/users/{userId}":
put: put:
operationId: updateUser operationId: update
summary: Update a user summary: Update a user
tags: tags:
- users - users
@ -1827,7 +1827,7 @@ paths:
user: user:
$ref: "#/components/examples/user" $ref: "#/components/examples/user"
delete: delete:
operationId: deleteUser operationId: delete
summary: Delete a user summary: Delete a user
tags: tags:
- users - users
@ -1844,7 +1844,7 @@ paths:
user: user:
$ref: "#/components/examples/user" $ref: "#/components/examples/user"
get: get:
operationId: getUserById operationId: getById
summary: Retrieve a user summary: Retrieve a user
tags: tags:
- users - users
@ -1862,7 +1862,7 @@ paths:
$ref: "#/components/examples/user" $ref: "#/components/examples/user"
/users/search: /users/search:
post: post:
operationId: searchUsers operationId: search
summary: Search for users summary: Search for users
description: Based on user properties (currently only name) search for users. description: Based on user properties (currently only name) search for users.
tags: tags:

2
packages/server/src/api/controllers/plugin/index.ts
View file

@ -129,6 +129,6 @@ export async function processUploadedPlugin(
} }
const doc = await plugins.storePlugin(metadata, directory, source) const doc = await plugins.storePlugin(metadata, directory, source)
ClientAppSocket.emit("plugins-update", { name: doc.name, hash: doc.hash }) ClientAppSocket.emit("plugin-update", { name: doc.name, hash: doc.hash })
return doc return doc
} }

10
packages/server/src/api/routes/public/applications.ts
View file

@ -9,7 +9,7 @@ const read = [],
* @openapi * @openapi
* /applications: * /applications:
* post: * post:
* operationId: createApplication * operationId: create
* summary: Create an application * summary: Create an application
* tags: * tags:
* - applications * - applications
@ -42,7 +42,7 @@ write.push(
* @openapi * @openapi
* /applications/{appId}: * /applications/{appId}:
* put: * put:
* operationId: updateApplication * operationId: update
* summary: Update an application * summary: Update an application
* tags: * tags:
* - applications * - applications
@ -75,7 +75,7 @@ write.push(
* @openapi * @openapi
* /applications/{appId}: * /applications/{appId}:
* delete: * delete:
* operationId: deleteApplication * operationId: delete
* summary: Delete an application * summary: Delete an application
* tags: * tags:
* - applications * - applications
@ -98,7 +98,7 @@ write.push(new Endpoint("delete", "/applications/:appId", controller.destroy))
* @openapi * @openapi
* /applications/{appId}: * /applications/{appId}:
* get: * get:
* operationId: getApplicationById * operationId: getById
* summary: Retrieve an application * summary: Retrieve an application
* tags: * tags:
* - applications * - applications
@ -121,7 +121,7 @@ read.push(new Endpoint("get", "/applications/:appId", controller.read))
* @openapi * @openapi
* /applications/search: * /applications/search:
* post: * post:
* operationId: searchApplications * operationId: search
* summary: Search for applications * summary: Search for applications
* description: Based on application properties (currently only name) search for applications. * description: Based on application properties (currently only name) search for applications.
* tags: * tags:

4
packages/server/src/api/routes/public/queries.ts
View file

@ -9,7 +9,7 @@ const read = [],
* @openapi * @openapi
* /queries/{queryId}: * /queries/{queryId}:
* post: * post:
* operationId: executeQuery * operationId: execute
* summary: Execute a query * summary: Execute a query
* description: Queries which have been created within a Budibase app can be executed using this, * description: Queries which have been created within a Budibase app can be executed using this,
* tags: * tags:
@ -43,7 +43,7 @@ write.push(new Endpoint("post", "/queries/:queryId", controller.execute))
* @openapi * @openapi
* /queries/search: * /queries/search:
* post: * post:
* operationId: searchQueries * operationId: search
* summary: Search for queries * summary: Search for queries
* description: Based on query properties (currently only name) search for queries. * description: Based on query properties (currently only name) search for queries.
* tags: * tags:

10
packages/server/src/api/routes/public/rows.ts
View file

@ -9,7 +9,7 @@ const read = [],
* @openapi * @openapi
* /tables/{tableId}/rows: * /tables/{tableId}/rows:
* post: * post:
* operationId: createRow * operationId: create
* summary: Create a row * summary: Create a row
* description: Creates a row within the specified table. * description: Creates a row within the specified table.
* tags: * tags:
@ -44,7 +44,7 @@ write.push(new Endpoint("post", "/tables/:tableId/rows", controller.create))
* @openapi * @openapi
* /tables/{tableId}/rows/{rowId}: * /tables/{tableId}/rows/{rowId}:
* put: * put:
* operationId: updateRow * operationId: update
* summary: Update a row * summary: Update a row
* description: Updates a row within the specified table. * description: Updates a row within the specified table.
* tags: * tags:
@ -81,7 +81,7 @@ write.push(
* @openapi * @openapi
* /tables/{tableId}/rows/{rowId}: * /tables/{tableId}/rows/{rowId}:
* delete: * delete:
* operationId: deleteRow * operationId: delete
* summary: Delete a row * summary: Delete a row
* description: Deletes a row within the specified table. * description: Deletes a row within the specified table.
* tags: * tags:
@ -109,7 +109,7 @@ write.push(
* @openapi * @openapi
* /tables/{tableId}/rows/{rowId}: * /tables/{tableId}/rows/{rowId}:
* get: * get:
* operationId: getRowById * operationId: getById
* summary: Retrieve a row * summary: Retrieve a row
* description: This gets a single row, it will be enriched with the full related rows, rather than * description: 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. * the squashed "primaryDisplay" format returned by the search endpoint.
@ -136,7 +136,7 @@ read.push(new Endpoint("get", "/tables/:tableId/rows/:rowId", controller.read))
* @openapi * @openapi
* /tables/{tableId}/rows/search: * /tables/{tableId}/rows/search:
* post: * post:
* operationId: searchRows * operationId: search
* summary: Search for rows * summary: Search for rows
* tags: * tags:
* - rows * - rows

10
packages/server/src/api/routes/public/tables.ts
View file

@ -9,7 +9,7 @@ const read = [],
* @openapi * @openapi
* /tables: * /tables:
* post: * post:
* operationId: createTable * operationId: create
* summary: Create a table * summary: Create a table
* description: Create a table, this could be internal or external. * description: Create a table, this could be internal or external.
* tags: * tags:
@ -46,7 +46,7 @@ write.push(
* @openapi * @openapi
* /tables/{tableId}: * /tables/{tableId}:
* put: * put:
* operationId: updateTable * operationId: update
* summary: Update a table * summary: Update a table
* description: Update a table, this could be internal or external. * description: Update a table, this could be internal or external.
* tags: * tags:
@ -83,7 +83,7 @@ write.push(
* @openapi * @openapi
* /tables/{tableId}: * /tables/{tableId}:
* delete: * delete:
* operationId: deleteTable * operationId: delete
* summary: Delete a table * summary: Delete a table
* description: Delete a table, this could be internal or external. * description: Delete a table, this could be internal or external.
* tags: * tags:
@ -108,7 +108,7 @@ write.push(new Endpoint("delete", "/tables/:tableId", controller.destroy))
* @openapi * @openapi
* /tables/{tableId}: * /tables/{tableId}:
* get: * get:
* operationId: getTableById * operationId: getById
* summary: Retrieve a table * summary: Retrieve a table
* description: Lookup a table, this could be internal or external. * description: Lookup a table, this could be internal or external.
* tags: * tags:
@ -133,7 +133,7 @@ read.push(new Endpoint("get", "/tables/:tableId", controller.read))
* @openapi * @openapi
* /tables/search: * /tables/search:
* post: * post:
* operationId: searchTables * operationId: search
* summary: Search for tables * summary: Search for tables
* description: Based on table properties (currently only name) search for tables. This could be * description: Based on table properties (currently only name) search for tables. This could be
* an internal or an external table. * an internal or an external table.

10
packages/server/src/api/routes/public/users.ts
View file

@ -9,7 +9,7 @@ const read = [],
* @openapi * @openapi
* /users: * /users:
* post: * post:
* operationId: createUser * operationId: create
* summary: Create a user * summary: Create a user
* tags: * tags:
* - users * - users
@ -36,7 +36,7 @@ write.push(new Endpoint("post", "/users", controller.create))
* @openapi * @openapi
* /users/{userId}: * /users/{userId}:
* put: * put:
* operationId: updateUser * operationId: update
* summary: Update a user * summary: Update a user
* tags: * tags:
* - users * - users
@ -65,7 +65,7 @@ write.push(new Endpoint("put", "/users/:userId", controller.update))
* @openapi * @openapi
* /users/{userId}: * /users/{userId}:
* delete: * delete:
* operationId: deleteUser * operationId: delete
* summary: Delete a user * summary: Delete a user
* tags: * tags:
* - users * - users
@ -88,7 +88,7 @@ write.push(new Endpoint("delete", "/users/:userId", controller.destroy))
* @openapi * @openapi
* /users/{userId}: * /users/{userId}:
* get: * get:
* operationId: getUserById * operationId: getById
* summary: Retrieve a user * summary: Retrieve a user
* tags: * tags:
* - users * - users
@ -111,7 +111,7 @@ read.push(new Endpoint("get", "/users/:userId", controller.read))
* @openapi * @openapi
* /users/search: * /users/search:
* post: * post:
* operationId: searchUsers * operationId: search
* summary: Search for users * summary: Search for users
* description: Based on user properties (currently only name) search for users. * description: Based on user properties (currently only name) search for users.
* tags: * tags:

443
packages/server/src/definitions/openapi.ts
View file

@ -5,67 +5,67 @@
export interface paths { export interface paths {
"/applications": { "/applications": {
post: operations["createApplication"]; post: operations["create"];
}; };
"/applications/{appId}": { "/applications/{appId}": {
get: operations["getApplicationById"]; get: operations["getById"];
put: operations["updateApplication"]; put: operations["update"];
delete: operations["deleteApplication"]; delete: operations["delete"];
}; };
"/applications/search": { "/applications/search": {
/** Based on application properties (currently only name) search for applications. */ /** Based on application properties (currently only name) search for applications. */
post: operations["searchApplications"]; post: operations["search"];
}; };
"/queries/{queryId}": { "/queries/{queryId}": {
/** Queries which have been created within a Budibase app can be executed using this, */ /** Queries which have been created within a Budibase app can be executed using this, */
post: operations["executeQuery"]; post: operations["execute"];
}; };
"/queries/search": { "/queries/search": {
/** Based on query properties (currently only name) search for queries. */ /** Based on query properties (currently only name) search for queries. */
post: operations["searchQueries"]; post: operations["search"];
}; };
"/tables/{tableId}/rows": { "/tables/{tableId}/rows": {
/** Creates a row within the specified table. */ /** Creates a row within the specified table. */
post: operations["createRow"]; post: operations["create"];
}; };
"/tables/{tableId}/rows/{rowId}": { "/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. */ /** 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: operations["getRowById"]; get: operations["getById"];
/** Updates a row within the specified table. */ /** Updates a row within the specified table. */
put: operations["updateRow"]; put: operations["update"];
/** Deletes a row within the specified table. */ /** Deletes a row within the specified table. */
delete: operations["deleteRow"]; delete: operations["delete"];
}; };
"/tables/{tableId}/rows/search": { "/tables/{tableId}/rows/search": {
post: operations["searchRows"]; post: operations["search"];
}; };
"/tables": { "/tables": {
/** Create a table, this could be internal or external. */ /** Create a table, this could be internal or external. */
post: operations["createTable"]; post: operations["create"];
}; };
"/tables/{tableId}": { "/tables/{tableId}": {
/** Lookup a table, this could be internal or external. */ /** Lookup a table, this could be internal or external. */
get: operations["getTableById"]; get: operations["getById"];
/** Update a table, this could be internal or external. */ /** Update a table, this could be internal or external. */
put: operations["updateTable"]; put: operations["update"];
/** Delete a table, this could be internal or external. */ /** Delete a table, this could be internal or external. */
delete: operations["deleteTable"]; delete: operations["delete"];
}; };
"/tables/search": { "/tables/search": {
/** Based on table properties (currently only name) search for tables. This could be an internal or an external table. */ /** Based on table properties (currently only name) search for tables. This could be an internal or an external table. */
post: operations["searchTables"]; post: operations["search"];
}; };
"/users": { "/users": {
post: operations["createUser"]; post: operations["create"];
}; };
"/users/{userId}": { "/users/{userId}": {
get: operations["getUserById"]; get: operations["getById"];
put: operations["updateUser"]; put: operations["update"];
delete: operations["deleteUser"]; delete: operations["delete"];
}; };
"/users/search": { "/users/search": {
/** Based on user properties (currently only name) search for users. */ /** Based on user properties (currently only name) search for users. */
post: operations["searchUsers"]; post: operations["search"];
}; };
} }
@ -704,87 +704,81 @@ export interface components {
} }
export interface operations { export interface operations {
createApplication: { create: {
parameters: {
header: {
/** The ID of the app which this request is targeting. */
"x-budibase-app-id": components["parameters"]["appId"];
};
};
responses: { responses: {
/** Returns the created application. */ /** Returns the created user. */
200: { 200: {
content: { content: {
"application/json": components["schemas"]["applicationOutput"]; "application/json": components["schemas"]["userOutput"];
}; };
}; };
}; };
requestBody: { requestBody: {
content: { content: {
"application/json": components["schemas"]["application"]; "application/json": components["schemas"]["user"];
}; };
}; };
}; };
getApplicationById: { getById: {
parameters: { parameters: {
path: { path: {
/** The ID of the app which this request is targeting. */ /** The ID of the user which this request is targeting. */
appId: components["parameters"]["appIdUrl"]; userId: components["parameters"]["userId"];
}; };
}; };
responses: { responses: {
/** Returns the retrieved application. */ /** Returns the retrieved user. */
200: { 200: {
content: { content: {
"application/json": components["schemas"]["applicationOutput"]; "application/json": components["schemas"]["userOutput"];
}; };
}; };
}; };
}; };
updateApplication: { update: {
parameters: { parameters: {
path: { path: {
/** The ID of the app which this request is targeting. */ /** The ID of the user which this request is targeting. */
appId: components["parameters"]["appIdUrl"]; userId: components["parameters"]["userId"];
}; };
}; };
responses: { responses: {
/** Returns the updated application. */ /** Returns the updated user. */
200: { 200: {
content: { content: {
"application/json": components["schemas"]["applicationOutput"]; "application/json": components["schemas"]["userOutput"];
}; };
}; };
}; };
requestBody: { requestBody: {
content: { content: {
"application/json": components["schemas"]["application"]; "application/json": components["schemas"]["user"];
}; };
}; };
}; };
deleteApplication: { delete: {
parameters: { parameters: {
path: { path: {
/** The ID of the app which this request is targeting. */ /** The ID of the user which this request is targeting. */
appId: components["parameters"]["appIdUrl"]; userId: components["parameters"]["userId"];
}; };
}; };
responses: { responses: {
/** Returns the deleted application. */ /** Returns the deleted user. */
200: { 200: {
content: { content: {
"application/json": components["schemas"]["applicationOutput"]; "application/json": components["schemas"]["userOutput"];
}; };
}; };
}; };
}; };
/** Based on application properties (currently only name) search for applications. */ /** Based on user properties (currently only name) search for users. */
searchApplications: { search: {
responses: { responses: {
/** Returns the applications that were found based on the search parameters. */ /** Returns the found users based on search parameters. */
200: { 200: {
content: { content: {
"application/json": components["schemas"]["applicationSearch"]; "application/json": components["schemas"]["userSearch"];
}; };
}; };
}; };
@ -795,7 +789,7 @@ export interface operations {
}; };
}; };
/** Queries which have been created within a Budibase app can be executed using this, */ /** Queries which have been created within a Budibase app can be executed using this, */
executeQuery: { execute: {
parameters: { parameters: {
path: { path: {
/** The ID of the query which this request is targeting. */ /** The ID of the query which this request is targeting. */
@ -820,349 +814,6 @@ export interface operations {
}; };
}; };
}; };
/** Based on query properties (currently only name) search for queries. */
searchQueries: {
parameters: {
header: {
/** The ID of the app which this request is targeting. */
"x-budibase-app-id": components["parameters"]["appId"];
};
};
responses: {
/** Returns the queries found based on the search parameters. */
200: {
content: {
"application/json": components["schemas"]["querySearch"];
};
};
};
requestBody: {
content: {
"application/json": components["schemas"]["nameSearch"];
};
};
};
/** Creates a row within the specified table. */
createRow: {
parameters: {
path: {
/** The ID of the table which this request is targeting. */
tableId: components["parameters"]["tableId"];
};
header: {
/** The ID of the app which this request is targeting. */
"x-budibase-app-id": components["parameters"]["appId"];
};
};
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: {
"application/json": components["schemas"]["rowOutput"];
};
};
};
requestBody: {
content: {
"application/json": components["schemas"]["row"];
};
};
};
/** 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. */
getRowById: {
parameters: {
path: {
/** The ID of the table which this request is targeting. */
tableId: components["parameters"]["tableId"];
/** The ID of the row which this request is targeting. */
rowId: components["parameters"]["rowId"];
};
header: {
/** The ID of the app which this request is targeting. */
"x-budibase-app-id": components["parameters"]["appId"];
};
};
responses: {
/** Returns the retrieved row. */
200: {
content: {
"application/json": components["schemas"]["rowOutput"];
};
};
};
};
/** Updates a row within the specified table. */
updateRow: {
parameters: {
path: {
/** The ID of the table which this request is targeting. */
tableId: components["parameters"]["tableId"];
/** The ID of the row which this request is targeting. */
rowId: components["parameters"]["rowId"];
};
header: {
/** The ID of the app which this request is targeting. */
"x-budibase-app-id": components["parameters"]["appId"];
};
};
responses: {
/** Returns the created row, including the ID which has been generated for it. */
200: {
content: {
"application/json": components["schemas"]["rowOutput"];
};
};
};
requestBody: {
content: {
"application/json": components["schemas"]["row"];
};
};
};
/** Deletes a row within the specified table. */
deleteRow: {
parameters: {
path: {
/** The ID of the table which this request is targeting. */
tableId: components["parameters"]["tableId"];
/** The ID of the row which this request is targeting. */
rowId: components["parameters"]["rowId"];
};
header: {
/** The ID of the app which this request is targeting. */
"x-budibase-app-id": components["parameters"]["appId"];
};
};
responses: {
/** Returns the deleted row, including the ID which has been generated for it. */
200: {
content: {
"application/json": components["schemas"]["rowOutput"];
};
};
};
};
searchRows: {
parameters: {
path: {
/** The ID of the table which this request is targeting. */
tableId: components["parameters"]["tableId"];
};
header: {
/** The ID of the app which this request is targeting. */
"x-budibase-app-id": components["parameters"]["appId"];
};
};
responses: {
/** The response will contain an array of rows that match the search parameters. */
200: {
content: {
"application/json": components["schemas"]["searchOutput"];
};
};
};
requestBody: {
content: {
"application/json": components["schemas"]["rowSearch"];
};
};
};
/** Create a table, this could be internal or external. */
createTable: {
parameters: {
header: {
/** The ID of the app which this request is targeting. */
"x-budibase-app-id": components["parameters"]["appId"];
};
};
responses: {
/** Returns the created table, including the ID which has been generated for it. This can be internal or external datasources. */
200: {
content: {
"application/json": components["schemas"]["tableOutput"];
};
};
};
requestBody: {
content: {
"application/json": components["schemas"]["table"];
};
};
};
/** Lookup a table, this could be internal or external. */
getTableById: {
parameters: {
path: {
/** The ID of the table which this request is targeting. */
tableId: components["parameters"]["tableId"];
};
header: {
/** The ID of the app which this request is targeting. */
"x-budibase-app-id": components["parameters"]["appId"];
};
};
responses: {
/** Returns the retrieved table. */
200: {
content: {
"application/json": components["schemas"]["tableOutput"];
};
};
};
};
/** Update a table, this could be internal or external. */
updateTable: {
parameters: {
path: {
/** The ID of the table which this request is targeting. */
tableId: components["parameters"]["tableId"];
};
header: {
/** The ID of the app which this request is targeting. */
"x-budibase-app-id": components["parameters"]["appId"];
};
};
responses: {
/** Returns the updated table. */
200: {
content: {
"application/json": components["schemas"]["tableOutput"];
};
};
};
requestBody: {
content: {
"application/json": components["schemas"]["table"];
};
};
};
/** Delete a table, this could be internal or external. */
deleteTable: {
parameters: {
path: {
/** The ID of the table which this request is targeting. */
tableId: components["parameters"]["tableId"];
};
header: {
/** The ID of the app which this request is targeting. */
"x-budibase-app-id": components["parameters"]["appId"];
};
};
responses: {
/** Returns the deleted table. */
200: {
content: {
"application/json": components["schemas"]["tableOutput"];
};
};
};
};
/** Based on table properties (currently only name) search for tables. This could be an internal or an external table. */
searchTables: {
parameters: {
header: {
/** The ID of the app which this request is targeting. */
"x-budibase-app-id": components["parameters"]["appId"];
};
};
responses: {
/** Returns the found tables, based on the search parameters. */
200: {
content: {
"application/json": components["schemas"]["tableSearch"];
};
};
};
requestBody: {
content: {
"application/json": components["schemas"]["nameSearch"];
};
};
};
createUser: {
responses: {
/** Returns the created user. */
200: {
content: {
"application/json": components["schemas"]["userOutput"];
};
};
};
requestBody: {
content: {
"application/json": components["schemas"]["user"];
};
};
};
getUserById: {
parameters: {
path: {
/** The ID of the user which this request is targeting. */
userId: components["parameters"]["userId"];
};
};
responses: {
/** Returns the retrieved user. */
200: {
content: {
"application/json": components["schemas"]["userOutput"];
};
};
};
};
updateUser: {
parameters: {
path: {
/** The ID of the user which this request is targeting. */
userId: components["parameters"]["userId"];
};
};
responses: {
/** Returns the updated user. */
200: {
content: {
"application/json": components["schemas"]["userOutput"];
};
};
};
requestBody: {
content: {
"application/json": components["schemas"]["user"];
};
};
};
deleteUser: {
parameters: {
path: {
/** The ID of the user which this request is targeting. */
userId: components["parameters"]["userId"];
};
};
responses: {
/** Returns the deleted user. */
200: {
content: {
"application/json": components["schemas"]["userOutput"];
};
};
};
};
/** Based on user properties (currently only name) search for users. */
searchUsers: {
responses: {
/** Returns the found users based on search parameters. */
200: {
content: {
"application/json": components["schemas"]["userSearch"];
};
};
};
requestBody: {
content: {
"application/json": components["schemas"]["nameSearch"];
};
};
};
} }
export interface external {} export interface external {}