From 9e9f14d1b744148106318d4a68967bfcd14f9414 Mon Sep 17 00:00:00 2001 From: Sam Rose Date: Mon, 9 Sep 2024 16:45:15 +0100 Subject: [PATCH] More comments. --- .../src/integrations/tests/utils/googlesheets.ts | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/packages/server/src/integrations/tests/utils/googlesheets.ts b/packages/server/src/integrations/tests/utils/googlesheets.ts index 70481e0e0d..a690a105fb 100644 --- a/packages/server/src/integrations/tests/utils/googlesheets.ts +++ b/packages/server/src/integrations/tests/utils/googlesheets.ts @@ -1,3 +1,12 @@ +// In this file is a mock implementation of the Google Sheets API. It is used +// to test the Google Sheets integration, and it keeps track of a single +// spreadsheet with many sheets. It aims to be a faithful recreation of the +// Google Sheets API, but it is not a perfect recreation. Some fields are +// missing if they aren't relevant to our use of the API. It's possible that +// this will cause problems for future feature development, but the original +// development of these tests involved hitting Google's APIs directly and +// examining the responses. If we couldn't find a good example of something in +// use, it wasn't included. import { Datasource } from "@budibase/types" import nock from "nock" import { GoogleSheetsConfig } from "../../googlesheets" @@ -13,6 +22,7 @@ interface Range { column: number } +// https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/sheets#DimensionProperties interface DimensionProperties { hiddenByFilter: boolean hiddenByUser: boolean