Merge bug fix - mixed up property descriptions

Redocly#1121

demo/playground/hmr-playground.tsx

@@ -26,9 +26,12 @@ const specUrl = 'test.json';
 
 let store;
 const options: RedocRawOptions = {
-  nativeScrollbars: false,
   disableSearch: true,
+  hideDownloadButton: true,
+  jsonSampleExpandLevel: 3,
   pathInMiddlePanel: true,
+  requiredPropsFirst: true,
+  sortPropsAlphabetically: true,
   theme: {
     spacing: {
       unit: 4,

package.json

@@ -1,6 +1,6 @@
 {
   "name": "kentico-kontent-docs-redoc",
-  "version": "3.0.2",
+  "version": "3.0.3",
   "description": "ReDoc",
   "repository": {
     "type": "git",

src/services/models/Operation.ts

@@ -154,12 +154,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

src/services/models/Schema.ts

@@ -251,7 +251,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) {
@@ -280,11 +280,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) {

src/utils/openapi.ts

@@ -1,6 +1,7 @@
 import { dirname } from 'path';
 const URLtemplate = require('url-template');
 
+import { FieldModel } from '../services/models';
 import { OpenAPIParser } from '../services/OpenAPIParser';
 import {
   OpenAPIEncoding,
@@ -413,25 +414,29 @@ export function humanizeConstraints(schema: OpenAPISchema): string[] {
   return res;
 }
 
-export function sortByRequired(
-  fields: Array<{ required: boolean; name: string }>,
-  order: string[] = [],
-) {
-  fields.sort((a, b) => {
-    if (!a.required && b.required) {
-      return 1;
-    } else if (a.required && !b.required) {
-      return -1;
-    } else if (a.required && b.required) {
-      return order.indexOf(a.name) - order.indexOf(b.name);
+export function sortByRequired(fields: FieldModel[], order: string[] = []) {
+  const unrequiredFields: FieldModel[] = [];
+  const orderedFields: FieldModel[] = [];
+  const unorderedFields: FieldModel[] = [];
+
+  fields.forEach(field => {
+    if (field.required) {
+      order.includes(field.name) ? orderedFields.push(field) : unorderedFields.push(field);
     } else {
-      return 0;
+      unrequiredFields.push(field);
     }
   });
+
+  orderedFields.sort((a, b) => order.indexOf(a.name) - order.indexOf(b.name));
+
+  return [...orderedFields, ...unorderedFields, ...unrequiredFields];
 }
 
-export function sortByField<T extends string>(fields: Array<{ [P in T]: string }>, param: T) {
-  fields.sort((a, b) => {
+export function sortByField(
+  fields: FieldModel[],
+  param: keyof Pick<FieldModel, 'name' | 'description' | 'kind'>,
+) {
+  return [...fields].sort((a, b) => {
     return a[param].localeCompare(b[param]);
   });
 }