Add comments describing reasoning for query field name aliases

Arize-ai · Nov 25, 2024 · 3a2a07f · 3a2a07f
1 parent 3d93dab
commit 3a2a07f
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/app/src/pages/playground/InvocationParametersFormFields.tsx b/app/src/pages/playground/InvocationParametersFormFields.tsx
@@ -221,6 +221,10 @@ export const InvocationParametersFormFields = ({
               required
               canonicalName
             }
+            # defaultValue must be aliased because Relay will not create a union type for fields with the same name
+            # follow the naming convention of the field type e.g. floatDefaultValue for FloatInvocationParameter
+            # default value mapping elsewhere in playground code relies on this naming convention
+            # https://github.com/facebook/relay/issues/3776
             ... on BoundedFloatInvocationParameter {
               minValue
               maxValue

diff --git a/app/src/pages/playground/ModelSupportedParamsFetcher.tsx b/app/src/pages/playground/ModelSupportedParamsFetcher.tsx
@@ -39,6 +39,10 @@ export const ModelSupportedParamsFetcher = ({
               canonicalName
               required
             }
+            # defaultValue must be aliased because Relay will not create a union type for fields with the same name
+            # follow the naming convention of the field type e.g. floatDefaultValue for FloatInvocationParameter
+            # default value mapping elsewhere in playground code relies on this naming convention
+            # https://github.com/facebook/relay/issues/3776
             ... on BooleanInvocationParameter {
               booleanDefaultValue: defaultValue
               invocationInputField