encoding/openapi: define strict order on fields
This gives nicer results, but also makes the diffs
when supporting structural OpenAPI (for CRDs)
more pallatable.
The prepend option is then no longer necessary.
This also exposed a bug where the wrong fields
were uniqued in the simplify stage.
Change-Id: Ib73df14800447cf2d63adbd77da7fb01f3e73498
Reviewed-on: https://cue-review.googlesource.com/c/cue/+/2802
Reviewed-by: Marcel van Lohuizen <mpvl@golang.org>
diff --git a/encoding/openapi/build.go b/encoding/openapi/build.go
index ba64a67..c491a1c 100644
--- a/encoding/openapi/build.go
+++ b/encoding/openapi/build.go
@@ -191,15 +191,47 @@
}
if len(doc) > 0 {
str := strings.TrimSpace(strings.Join(doc, "\n\n"))
- schema.prepend("description", str)
+ schema.Set("description", str)
}
}
simplify(c, schema)
+ sortSchema(schema)
+
return schema
}
+func sortSchema(s *oaSchema) {
+ sort.Slice(s.kvs, func(i, j int) bool {
+ pi := fieldOrder[s.kvs[i].Key]
+ pj := fieldOrder[s.kvs[j].Key]
+ if pi != pj {
+ return pi > pj
+ }
+ return s.kvs[i].Key < s.kvs[j].Key
+ })
+}
+
+var fieldOrder = map[string]int{
+ "description": 31,
+ "type": 30,
+ "format": 29,
+ "required": 28,
+ "properties": 27,
+ "minProperties": 26,
+ "maxProperties": 25,
+ "minimum": 24,
+ "exclusiveMinimum": 23,
+ "maximum": 22,
+ "exclusiveMaximum": 21,
+ "minItems": 18,
+ "maxItems": 17,
+ "minLength": 16,
+ "maxLength": 15,
+ "items": 14,
+}
+
func (b *builder) resolve(v cue.Value) cue.Value {
// Cycles are not allowed when expanding references. Right now we just
// cap the depth of evaluation at 30.
