rapidoc 9.1.3 → 9.1.4

package/src/utils/schema-utils.js

@@ -389,10 +389,12 @@ export function schemaToSampleObj(schema, config = { }) {
         const oneOfSamples = schemaToSampleObj(schema.oneOf[key], config);
         for (const sampleKey in oneOfSamples) {
           // 2. In the final example include a one-of item along with properties
-          const finalExample = Object.assign(oneOfSamples[sampleKey], objWithSchemaProps);
-          obj[`example-${i}`] = finalExample;
-          addSchemaInfoToExample(schema.oneOf[key], obj[`example-${i}`]);
-          i++;
+          if (oneOfSamples[sampleKey] === null) {
+            const finalExample = Object.assign(oneOfSamples[sampleKey], objWithSchemaProps);
+            obj[`example-${i}`] = finalExample;
+            addSchemaInfoToExample(schema.oneOf[key], obj[`example-${i}`]);
+            i++;
+          }
         }
       }
     }
@@ -436,10 +438,10 @@ export function schemaToSampleObj(schema, config = { }) {
       obj['example-0'] = schema.example;
     } else {
       for (const propertyName in schema.properties) {
-        if (schema.properties[propertyName].deprecated && !config.includeDeprecated) { continue; }
-        if (schema.properties[propertyName].readOnly && !config.includeReadOnly) { continue; }
-        if (schema.properties[propertyName].writeOnly && !config.includeWriteOnly) { continue; }
-        if (schema.properties[propertyName].type === 'array' || schema.properties[propertyName].items) {
+        if (schema.properties[propertyName]?.deprecated && !config.includeDeprecated) { continue; }
+        if (schema.properties[propertyName]?.readOnly && !config.includeReadOnly) { continue; }
+        if (schema.properties[propertyName]?.writeOnly && !config.includeWriteOnly) { continue; }
+        if (schema.properties[propertyName]?.type === 'array' || schema.properties[propertyName]?.items) {
           if (schema.properties[propertyName].example) {
             addPropertyExampleToObjectExamples(schema.properties[propertyName].example, obj, propertyName);
           } else if (schema.properties[propertyName]?.items?.example) { // schemas and properties support single example but not multiple examples.
@@ -622,6 +624,7 @@ export function schemaInObjectNotation(schema, obj, level = 0, suffix = '') {
     obj['::description'] = schema.description || '';
     obj['::type'] = 'object';
     obj['::deprecated'] = schema.deprecated || false;
+    obj['::readwrite'] = schema.readOnly ? 'readonly' : schema.writeOnly ? 'writeonly' : '';
     for (const key in schema.properties) {
       if (schema.required && schema.required.includes(key)) {
         obj[`${key}*`] = schemaInObjectNotation(schema.properties[key], {}, (level + 1));
@@ -639,6 +642,8 @@ export function schemaInObjectNotation(schema, obj, level = 0, suffix = '') {
         ? `array<${schema.items.description}>`
         : '';
     obj['::type'] = 'array';
+    obj['::deprecated'] = schema.deprecated || false;
+    obj['::readwrite'] = schema.readOnly ? 'readonly' : schema.writeOnly ? 'writeonly' : '';
     if (schema.items.items) {
       obj['::array-type'] = schema.items.items.type;
     }
@@ -654,7 +659,7 @@ export function schemaInObjectNotation(schema, obj, level = 0, suffix = '') {
 }
 
 /* Create Example object */
-export function generateExample(examples = '', example = '', schema, mimeType, includeReadOnly = true, includeWriteOnly = true, outputType = 'json', includeGeneratedExample = false) {
+export function generateExample(schema, mimeType, examples = '', example = '', includeReadOnly = true, includeWriteOnly = true, outputType = 'json', includeGeneratedExample = false) {
   const finalExamples = [];
   // First check if examples is provided
   if (examples) {

package/src/utils/spec-parser.js

@@ -1,6 +1,6 @@
 /* eslint-disable no-use-before-define */
 import OpenApiParser from '@apitools/openapi-parser';
-import marked from 'marked';
+import { marked } from 'marked';
 import { invalidCharsRegEx, rapidocApiKey, sleep } from '~/utils/common-utils';
 
 export default async function ProcessSpec(specUrl, generateMissingTags = false, sortTags = false, sortEndpointsBy = '', attrApiKey = '', attrApiKeyLocation = '', attrApiKeyValue = '', serverUrl = '') {
@@ -50,7 +50,7 @@ export default async function ProcessSpec(specUrl, generateMissingTags = false,
   // const pathGroups = groupByPaths(jsonParsedSpec);
 
   // Tags with Paths and WebHooks
-  const tags = groupByTags(jsonParsedSpec, generateMissingTags, sortTags, sortEndpointsBy);
+  const tags = groupByTags(jsonParsedSpec, sortEndpointsBy, generateMissingTags, sortTags);
 
   // Components
   const components = getComponents(jsonParsedSpec);
@@ -239,7 +239,7 @@ function getComponents(openApiSpec) {
   return components || [];
 }
 
-function groupByTags(openApiSpec, generateMissingTags = false, sortTags = false, sortEndpointsBy) {
+function groupByTags(openApiSpec, sortEndpointsBy, generateMissingTags = false, sortTags = false) {
   const supportedMethods = ['get', 'put', 'post', 'delete', 'patch', 'head', 'options']; // this is also used for ordering endpoints by methods
   const tags = openApiSpec.tags && Array.isArray(openApiSpec.tags)
     ? openApiSpec.tags.map((v) => ({

package/webpack.config.js

@@ -144,6 +144,7 @@ module.exports = {
   resolve: {
     fallback: {
       fs: false,
+      buffer: require.resolve('buffer'),
     },
     alias: {
       '~': path.resolve(__dirname, 'src'),

package/docs/specs/tenants.json

@@ -1,12 +0,0 @@
-{
-  "description": "Tenant Details",
-  "type": "object",
-  "properties": {
-    "empId"     : { "type": "string", "description": "Employee ID" },
-    "firstName" : { "type": "string", "description": "First name"  },
-    "lastName"  : { "type": "string", "description": "Last Name"   },
-    "jobTitle"  : { "type": "string", "description": "Job title"   },
-    "department": { "type": "string", "description": "Department name"},
-    "salary"    : { "type": "number", "description": "Salary per annum"}
-  }
-}