Merge pull request #20869 from vespa-engine/ogronnesby/document-tenant-info

Add comments to the tenant info classes

3 files changed, 28 insertions, 0 deletions

diff --git a/controller-api/src/main/java/com/yahoo/vespa/hosted/controller/tenant/TenantInfo.java b/controller-api/src/main/java/com/yahoo/vespa/hosted/controller/tenant/TenantInfo.java
index 91f7ed2162d..87d4f03b090 100644
--- a/controller-api/src/main/java/com/yahoo/vespa/hosted/controller/tenant/TenantInfo.java
+++ b/controller-api/src/main/java/com/yahoo/vespa/hosted/controller/tenant/TenantInfo.java
@@ -13,13 +13,35 @@ import java.util.Objects;
  * @author smorgrav
  */
 public class TenantInfo {
+    // Editable as 'Tenant Information - Company Name'
+    // Viewable in the 'Account - Profile' section as 'Company Name'
     private final String name;
+
+    // Editable as 'Tenant Information - Email'
+    // Not displayed outside of 'Edit profile'
     private final String email;
+
+    // Editable as 'Tenant Information - Website'
+    // Viewable in the 'Account - Profile' section at bottom of 'Contact Information'
     private final String website;
+
+    // Editable as 'Contact Information - Contact Name'
+    // Viewable in the 'Account - Profile' section in 'Contact Information'
     private final String contactName;
+
+    // Editable as 'Contact Information - Contact Email'
+    // Viewable in the 'Account - Profile' section in 'Contact Information'
     private final String contactEmail;
+
+    // Not editable in the account setting
+    // Not viewable.
+    // TODO: Remove
     private final String invoiceEmail;
+
+    // See class for more info
     private final TenantInfoAddress address;
+
+    // See class for more info
     private final TenantInfoBillingContact billingContact;
 
     TenantInfo(String name, String email, String website, String contactName, String contactEmail,
diff --git a/controller-api/src/main/java/com/yahoo/vespa/hosted/controller/tenant/TenantInfoAddress.java b/controller-api/src/main/java/com/yahoo/vespa/hosted/controller/tenant/TenantInfoAddress.java
index a838a86567a..740adde4519 100644
--- a/controller-api/src/main/java/com/yahoo/vespa/hosted/controller/tenant/TenantInfoAddress.java
+++ b/controller-api/src/main/java/com/yahoo/vespa/hosted/controller/tenant/TenantInfoAddress.java
@@ -16,6 +16,8 @@ import java.util.Objects;
  */
 public class TenantInfoAddress {
 
+    // All fields are editable in 'Edit Profile - Company Address'.
+    // The fields are not exposed outside the 'Edit Profile' form.
     private final String addressLines;
     private final String postalCodeOrZip;
     private final String city;
diff --git a/controller-api/src/main/java/com/yahoo/vespa/hosted/controller/tenant/TenantInfoBillingContact.java b/controller-api/src/main/java/com/yahoo/vespa/hosted/controller/tenant/TenantInfoBillingContact.java
index 177f0620d85..c875a19d57b 100644
--- a/controller-api/src/main/java/com/yahoo/vespa/hosted/controller/tenant/TenantInfoBillingContact.java
+++ b/controller-api/src/main/java/com/yahoo/vespa/hosted/controller/tenant/TenantInfoBillingContact.java
@@ -7,6 +7,10 @@ import java.util.Objects;
  * @author smorgrav
  */
 public class TenantInfoBillingContact {
+
+    // All fields are editable in 'Billing - Edit billing contact'
+    // Only 'name' and 'email' are exposed outside the 'Edit billing contact' form.
+    // All these fields are required by the billing process.
     private final String name;
     private final String email;
     private final String phone;