backport of commit e65d295 (#20905)

Co-authored-by: Max Bowsher <maxbowsher@gmail.com>
hashicorp · May 31, 2023 · 6daa1bd · 6daa1bd
1 parent d59a1ed
commit 6daa1bd
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git a/changelog/20881.txt b/changelog/20881.txt
@@ -0,0 +1,3 @@
+```release-note:improvement
+sdk/framework: Fix non-deterministic ordering of 'required' fields in OpenAPI spec
+```
diff --git a/sdk/framework/openapi.go b/sdk/framework/openapi.go
@@ -373,6 +373,10 @@ func documentPath(p *Path, specialPaths *logical.Paths, requestResponsePrefix st
 					s.Properties[name] = &p
 				}
 
+				// Make the ordering deterministic, so that the generated OpenAPI spec document, observed over several
+				// versions, doesn't contain spurious non-semantic changes.
+				sort.Strings(s.Required)
+
 				// If examples were given, use the first one as the sample
 				// of this schema.
 				if len(props.Examples) > 0 {