Fix non-deterministic ordering of 'required' field in OpenAPI spec (#…

…20881) * Fix non-deterministic ordering of 'required' field in OpenAPI spec Fixes a minor annoyance I discovered whilst comparing before and after OpenAPI specs whilst working on hashicorp/vault-client-go#180. Sort the entries in a JSON array which has set semantics, after we construct it by iterating a map (non-deterministic ordering). * changelog
hashicorp · May 31, 2023 · e65d295 · e65d295
1 parent b86f475
commit e65d295
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
@@ -383,6 +383,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 {