fix: fix sortByRequired (stabilise sort) (#1136)

fixes #1104 fixes #1121 fixes #1061
Redocly · Dec 13, 2019 · d92434d · d92434d
1 parent 1bf490c
commit d92434d
Show file tree

Hide file tree

Showing 4 changed files with 391 additions and 20 deletions.
diff --git a/src/services/models/Operation.ts b/src/services/models/Operation.ts
@@ -184,12 +184,11 @@ export class OperationModel implements IMenuItem {
     ).map(paramOrRef => new FieldModel(this.parser, paramOrRef, this.pointer, this.options));
 
     if (this.options.sortPropsAlphabetically) {
-      sortByField(_parameters, 'name');
+      return sortByField(_parameters, 'name');
     }
     if (this.options.requiredPropsFirst) {
-      sortByRequired(_parameters);
+      return sortByRequired(_parameters);
     }
-    return _parameters;
   }
 
   @memoize

diff --git a/src/services/models/Schema.ts b/src/services/models/Schema.ts
@@ -275,7 +275,7 @@ function buildFields(
   const props = schema.properties || {};
   const additionalProps = schema.additionalProperties;
   const defaults = schema.default || {};
-  const fields = Object.keys(props || []).map(fieldName => {
+  let fields = Object.keys(props || []).map(fieldName => {
     let field = props[fieldName];
 
     if (!field) {
@@ -304,11 +304,11 @@ function buildFields(
   });
 
   if (options.sortPropsAlphabetically) {
-    sortByField(fields, 'name');
+    fields = sortByField(fields, 'name');
   }
   if (options.requiredPropsFirst) {
     // if not sort alphabetically sort in the order from required keyword
-    sortByRequired(fields, !options.sortPropsAlphabetically ? schema.required : undefined);
+    fields = sortByRequired(fields, !options.sortPropsAlphabetically ? schema.required : undefined);
   }
 
   if (typeof additionalProps === 'object' || additionalProps === true) {