fix: Handle relations in table options descriptions

Author: erezrokah

docs/table_options.go

@@ -12,6 +12,15 @@ import (
 	invoschema "github.com/invopop/jsonschema"
 )
 
+func transformDescription(table *schema.Table, tableNamesToOptionsDocs map[string]string) {
+	if tableNamesToOptionsDocs[table.Name] != "" {
+		table.Description = table.Description + "\n\n" + tableNamesToOptionsDocs[table.Name]
+	}
+	for _, rel := range table.Relations {
+		transformDescription(rel, tableNamesToOptionsDocs)
+	}
+}
+
 func TableOptionsDescriptionTransformer(tableOptions any, jsonSchema string) (schema.Transform, error) {
 	var sc invoschema.Schema
 	if err := json.Unmarshal([]byte(jsonSchema), &sc); err != nil {
@@ -44,9 +53,7 @@ func TableOptionsDescriptionTransformer(tableOptions any, jsonSchema string) (sc
 	}
 
 	return func(table *schema.Table) error {
-		if tableNamesToOptionsDocs[table.Name] != "" {
-			table.Description = table.Description + "\n\n" + tableNamesToOptionsDocs[table.Name]
-		}
+		transformDescription(table, tableNamesToOptionsDocs)
 		return nil
 	}, nil
 }

docs/table_options_test.go

@@ -13,12 +13,19 @@ import (
 var testSchema string
 
 type testTableOptions struct {
-	Dummy testdata.DummyTableOptions `json:"dummy,omitempty"`
+	Dummy  testdata.DummyTableOptions `json:"dummy,omitempty"`
+	Dummy2 testdata.DummyTableOptions `json:"dummy2,omitempty"`
 }
 
 var testTable = &schema.Table{
 	Name:        "dummy",
 	Description: "This is a dummy table",
+	Relations: []*schema.Table{
+		{
+			Name:        "dummy2",
+			Description: "",
+		},
+	},
 }
 
 func TestTableOptionsDescriptionTransformer(t *testing.T) {
@@ -58,6 +65,9 @@ func TestTableOptionsDescriptionTransformer(t *testing.T) {
 			}
 			require.NoError(t, transformer(tt.args.table))
 			require.Equal(t, tt.wantDesc, tt.args.table.Description)
+			for _, rel := range tt.args.table.Relations {
+				require.NotEmpty(t, rel.Description)
+			}
 		})
 	}
 }