From 38760897bf4a5579a1df4e5ca1e1b8bae7ed5916 Mon Sep 17 00:00:00 2001 From: mike12345567 Date: Wed, 30 Oct 2024 14:40:13 +0000 Subject: [PATCH] Updating specs again. --- packages/server/specs/openapi.json | 9 +++++++++ packages/server/specs/openapi.yaml | 7 +++++++ packages/server/specs/parameters.ts | 10 ++++++++++ packages/server/src/definitions/openapi.ts | 14 ++++++++++++++ 4 files changed, 40 insertions(+) diff --git a/packages/server/specs/openapi.json b/packages/server/specs/openapi.json index c80f947fad..3af15e1f02 100644 --- a/packages/server/specs/openapi.json +++ b/packages/server/specs/openapi.json @@ -32,6 +32,15 @@ "type": "string" } }, + "viewId": { + "in": "path", + "name": "viewId", + "required": true, + "description": "The ID of the view which this request is targeting.", + "schema": { + "type": "string" + } + }, "rowId": { "in": "path", "name": "rowId", diff --git a/packages/server/specs/openapi.yaml b/packages/server/specs/openapi.yaml index 9a2ce6e0da..094957805f 100644 --- a/packages/server/specs/openapi.yaml +++ b/packages/server/specs/openapi.yaml @@ -23,6 +23,13 @@ components: description: The ID of the table which this request is targeting. schema: type: string + viewId: + in: path + name: viewId + required: true + description: The ID of the view which this request is targeting. + schema: + type: string rowId: in: path name: rowId diff --git a/packages/server/specs/parameters.ts b/packages/server/specs/parameters.ts index a4f2b27ae4..abc26c48d6 100644 --- a/packages/server/specs/parameters.ts +++ b/packages/server/specs/parameters.ts @@ -8,6 +8,16 @@ export const tableId = { }, } +export const viewId = { + in: "path", + name: "viewId", + required: true, + description: "The ID of the view which this request is targeting.", + schema: { + type: "string", + }, +} + export const rowId = { in: "path", name: "rowId", diff --git a/packages/server/src/definitions/openapi.ts b/packages/server/src/definitions/openapi.ts index 9d68e11185..a1e5d8202f 100644 --- a/packages/server/src/definitions/openapi.ts +++ b/packages/server/src/definitions/openapi.ts @@ -897,6 +897,8 @@ export interface components { parameters: { /** @description The ID of the table which this request is targeting. */ tableId: string; + /** @description The ID of the view which this request is targeting. */ + viewId: string; /** @description The ID of the row which this request is targeting. */ rowId: string; /** @description The ID of the app which this request is targeting. */ @@ -1514,6 +1516,10 @@ export interface operations { /** Lookup a view, this could be internal or external. */ viewGetById: { parameters: { + path: { + /** The ID of the view which this request is targeting. */ + viewId: components["parameters"]["viewId"]; + }; header: { /** The ID of the app which this request is targeting. */ "x-budibase-app-id": components["parameters"]["appId"]; @@ -1531,6 +1537,10 @@ export interface operations { /** Update a view, this can be against an internal or external table. */ viewUpdate: { parameters: { + path: { + /** The ID of the view which this request is targeting. */ + viewId: components["parameters"]["viewId"]; + }; header: { /** The ID of the app which this request is targeting. */ "x-budibase-app-id": components["parameters"]["appId"]; @@ -1553,6 +1563,10 @@ export interface operations { /** Delete a view, this can be against an internal or external table. */ viewDestroy: { parameters: { + path: { + /** The ID of the view which this request is targeting. */ + viewId: components["parameters"]["viewId"]; + }; header: { /** The ID of the app which this request is targeting. */ "x-budibase-app-id": components["parameters"]["appId"];