Support for x-gitbook-enum

Author: nolannbiron

packages/openapi-parser/src/types.ts

@@ -47,6 +47,21 @@ export interface OpenAPICustomOperationProperties {
      * Description in Document format.
      */
     'x-gitbook-description-document'?: object;
+
+    /**
+     * Enums with name and description
+     */
+    'x-enumDescriptions'?: object;
+
+    /**
+     * Enums with name and description
+     */
+    'x-gitbook-enum'?: {
+        [key: string]: {
+            description: string;
+            name: string;
+        };
+    };
 }
 
 /**

packages/react-openapi/src/OpenAPISchema.tsx

@@ -242,15 +242,33 @@ function OpenAPISchemaEnum(props: {
 }) {
     const { schema } = props;
 
-    if (!schema.enum || !schema.enum.length || !schema['x-enumDescriptions']) {
+    if (!schema.enum?.length || (!schema['x-enumDescriptions'] && !schema['x-gitbook-enum'])) {
         return null;
     }
 
     const enumValues = (() => {
+        if (schema['x-gitbook-enum']) {
+            return Object.entries(schema['x-gitbook-enum']).map(([_, { description, name }]) => {
+                return {
+                    value: name,
+                    description,
+                };
+            });
+        }
+
+        if (schema['x-enumDescriptions']) {
+            return Object.entries(schema['x-enumDescriptions']).map(([value, description]) => {
+                return {
+                    value,
+                    description,
+                };
+            });
+        }
+
         return schema.enum.map((value) => {
             return {
                 value,
-                description: schema['x-enumDescriptions']?.[value],
+                description: undefined,
             };
         });
     })();