From 530677c6fd6cb0abe5a6b8c42c08ac28d6ff9ef2 Mon Sep 17 00:00:00 2001 From: Ryan Oaks Date: Thu, 30 Jan 2025 13:31:37 -0500 Subject: [PATCH] Clarify when changing a List to a Set is considered breaking --- docs/content/breaking-changes/breaking-changes.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/content/breaking-changes/breaking-changes.md b/docs/content/breaking-changes/breaking-changes.md index 807a146b2889..82ec524a45fc 100644 --- a/docs/content/breaking-changes/breaking-changes.md +++ b/docs/content/breaking-changes/breaking-changes.md @@ -57,7 +57,9 @@ For more information, see * Removing or renaming a field * Changing field output type * Between primitive types, like changing a String to an Integer - * Between complex types like changing a List to a Set. + * Between complex types like changing a List to a Set. Note that List -> Set + can be considered non-breaking if the field is unordered and the order + returned from the API changes unpredictably. * Changing the field type between primitive and complex data types is not possible. For this scenario, field renames are preferred. * Making an optional field required or adding a new required field