From a1253179de81d6dcc336eb0eed3cd270380fdff8 Mon Sep 17 00:00:00 2001
From: Paul van Wichen <126611130+paul-van-wichen@users.noreply.github.com>
Date: Thu, 9 Jan 2025 16:02:03 -0500
Subject: [PATCH] DOC-2657 - update BE setup API to include GCP billing config
 schema info. (#713)

---
 .../BERegisteredSetupAccountAwsConfig.yaml       |  2 +-
 .../BERegisteredSetupAccountAzureConfig.yaml     |  2 +-
 ...BERegisteredSetupAccountGcpBillingConfig.yaml | 16 ++++++++++++++++
 .../BERegisteredSetupAccountGcpConfig.yaml       |  9 +++++++++
 .../BERegisteredSetupAccountUpdateRequest.yaml   |  1 +
 5 files changed, 28 insertions(+), 2 deletions(-)
 create mode 100644 api/services/beci/setup/schemas/BERegisteredSetupAccountGcpBillingConfig.yaml
 create mode 100644 api/services/beci/setup/schemas/BERegisteredSetupAccountGcpConfig.yaml

diff --git a/api/services/beci/setup/schemas/BERegisteredSetupAccountAwsConfig.yaml b/api/services/beci/setup/schemas/BERegisteredSetupAccountAwsConfig.yaml
index fe7b2c14..84f6a288 100644
--- a/api/services/beci/setup/schemas/BERegisteredSetupAccountAwsConfig.yaml
+++ b/api/services/beci/setup/schemas/BERegisteredSetupAccountAwsConfig.yaml
@@ -6,4 +6,4 @@ type: object
 required:
   - billingSource
 title: BERegisteredSetupAccountAwsConfig
-description: Configuration settings used to collect AWS billing data. Requires that the target Spot account is linked to an AWS account with billing data (e.g. master payer account).
+description: Configuration settings used to collect AWS billing data. The target Spot account must be linked to an AWS account with billing data (e.g. master payer account).
diff --git a/api/services/beci/setup/schemas/BERegisteredSetupAccountAzureConfig.yaml b/api/services/beci/setup/schemas/BERegisteredSetupAccountAzureConfig.yaml
index 01d854da..960ab026 100644
--- a/api/services/beci/setup/schemas/BERegisteredSetupAccountAzureConfig.yaml
+++ b/api/services/beci/setup/schemas/BERegisteredSetupAccountAzureConfig.yaml
@@ -1,4 +1,4 @@
 properties: {}
 type: object
 title: BERegisteredSetupAccountAzureConfig
-description: Configuration settings used to collect Azure billing data. Requires that the target Spot account is linked to an Azure billing account.
+description: Configuration settings used to collect Azure billing data. The target Spot account must be linked to an Azure billing account.
diff --git a/api/services/beci/setup/schemas/BERegisteredSetupAccountGcpBillingConfig.yaml b/api/services/beci/setup/schemas/BERegisteredSetupAccountGcpBillingConfig.yaml
new file mode 100644
index 00000000..abcf7c4a
--- /dev/null
+++ b/api/services/beci/setup/schemas/BERegisteredSetupAccountGcpBillingConfig.yaml
@@ -0,0 +1,16 @@
+properties:
+  tableId:
+    type: string
+    description: The BigQuery table ID that is used to export the billing data.
+  datasetId:
+    type: string
+    description: The BigQuery dataset ID that is used to export the billing data.
+  projectId:
+    type: string
+    description: The Google project ID that is used to export the billing data.
+type: object
+required:
+  - tableId
+  - datasetId
+  - projectId
+title: BERegisteredSetupAccountGcpBillingConfig
diff --git a/api/services/beci/setup/schemas/BERegisteredSetupAccountGcpConfig.yaml b/api/services/beci/setup/schemas/BERegisteredSetupAccountGcpConfig.yaml
new file mode 100644
index 00000000..8a434581
--- /dev/null
+++ b/api/services/beci/setup/schemas/BERegisteredSetupAccountGcpConfig.yaml
@@ -0,0 +1,9 @@
+properties:
+  googleBillingConfiguration:
+    $ref: BERegisteredSetupAccountGcpBillingConfig.yaml
+    description: Configuration settings used to collect Google billing data.
+type: object
+required:
+  - googleBillingConfiguration
+title: BERegisteredSetupAccountGcpConfig
+description: Configuration settings used to collect Google billing data. The target Spot account must be linked to a Google project where the billing data is exported.
diff --git a/api/services/beci/setup/schemas/BERegisteredSetupAccountUpdateRequest.yaml b/api/services/beci/setup/schemas/BERegisteredSetupAccountUpdateRequest.yaml
index 37ef161e..9b039e0e 100644
--- a/api/services/beci/setup/schemas/BERegisteredSetupAccountUpdateRequest.yaml
+++ b/api/services/beci/setup/schemas/BERegisteredSetupAccountUpdateRequest.yaml
@@ -8,6 +8,7 @@ properties:
       - type: object
       - $ref: BERegisteredSetupAccountAwsConfig.yaml
       - $ref: BERegisteredSetupAccountAzureConfig.yaml
+      - $ref: BERegisteredSetupAccountGcpConfig.yaml
     description: Configuration for the Billing Engine (e.g. location of the billing data)
     nullable: true
 type: object