feat: display multipleOf constrains (#1065)

Redocly · Dec 8, 2019 · 3e90133 · 3e90133
1 parent dc5430e
commit 3e90133
Show file tree

Hide file tree

Showing 3 changed files with 35 additions and 3 deletions.
diff --git a/demo/openapi.yaml b/demo/openapi.yaml
@@ -738,6 +738,7 @@ components:
               type: number
               description: Average amount of honey produced per day in ounces
               example: 3.14
+              multipleOf: .01
           required:
             - honeyPerDay
     Id:

diff --git a/src/utils/__tests__/openapi.test.ts b/src/utils/__tests__/openapi.test.ts
@@ -333,7 +333,8 @@ describe('Utils', () => {
     const itemConstraintSchema = (
       min: number | undefined = undefined,
       max: number | undefined = undefined,
-    ) => ({ type: 'array', minItems: min, maxItems: max });
+      multipleOf: number | undefined = undefined,
+    ) => ({ type: 'array', minItems: min, maxItems: max, multipleOf });
 
     it('should not have a humanized constraint without schema constraints', () => {
       expect(humanizeConstraints(itemConstraintSchema())).toHaveLength(0);
@@ -355,9 +356,21 @@ describe('Utils', () => {
       expect(humanizeConstraints(itemConstraintSchema(7, 7))).toContain('7 items');
     });
 
-    it('should have a humazined constraint when justMinItems is set, and it is equal to 1', () => {
+    it('should have a humanized constraint when justMinItems is set, and it is equal to 1', () => {
       expect(humanizeConstraints(itemConstraintSchema(1))).toContain('non-empty');
     });
+
+    it('should have a humanized constraint when multipleOf is set, and it is in format of /^0\\.0*1$/', () => {
+      expect(humanizeConstraints(itemConstraintSchema(undefined, undefined, 0.01))).toContain(
+        'decimal places <= 2',
+      );
+    });
+
+    it('should have a humanized constraint when multipleOf is set, and it is in format other than /^0\\.0*1$/', () => {
+      expect(humanizeConstraints(itemConstraintSchema(undefined, undefined, 0.5))).toContain(
+        'multiple of 0.5',
+      );
+    });
   });
 
   describe('OpenAPI pluralizeType', () => {
@@ -387,7 +400,9 @@ describe('Utils', () => {
       expect(pluralizeType('objects (Pet)')).toEqual('objects (Pet)');
       expect(pluralizeType('strings <email>')).toEqual('strings <email>');
       expect(pluralizeType('objects or strings')).toEqual('objects or strings');
-      expect(pluralizeType('objects (Pet) or numbers <int64>')).toEqual('objects (Pet) or numbers <int64>');
+      expect(pluralizeType('objects (Pet) or numbers <int64>')).toEqual(
+        'objects (Pet) or numbers <int64>',
+      );
     });
   });
 

diff --git a/src/utils/openapi.ts b/src/utils/openapi.ts
@@ -368,6 +368,17 @@ export function isNamedDefinition(pointer?: string): boolean {
   return /^#\/components\/schemas\/[^\/]+$/.test(pointer || '');
 }
 
+function humanizeMultipleOfConstraint(multipleOf: number | undefined): string | undefined {
+  if (multipleOf === undefined) {
+    return;
+  }
+  const strigifiedMultipleOf = multipleOf.toString(10);
+  if (!/^0\.0*1$/.test(strigifiedMultipleOf)) {
+    return `multiple of ${strigifiedMultipleOf}`;
+  }
+  return `decimal places <= ${strigifiedMultipleOf.split('.')[1].length}`;
+}
+
 function humanizeRangeConstraint(
   description: string,
   min: number | undefined,
@@ -406,6 +417,11 @@ export function humanizeConstraints(schema: OpenAPISchema): string[] {
     res.push(arrayRange);
   }
 
+  const multipleOfConstraint = humanizeMultipleOfConstraint(schema.multipleOf);
+  if (multipleOfConstraint !== undefined) {
+    res.push(multipleOfConstraint);
+  }
+
   let numberRange;
   if (schema.minimum !== undefined && schema.maximum !== undefined) {
     numberRange = schema.exclusiveMinimum ? '( ' : '[ ';