rapidoc 9.3.2 → 9.3.3

package/src/templates/endpoint-template.js

@@ -118,6 +118,7 @@ function endpointBodyTemplate(path) {
         <api-request
           class = "${this.renderStyle}-mode ${this.layout}-layout"
           style = "width:100%;"
+          webhook = "${path.isWebhook}"
           method = "${path.method}", 
           path = "${path.path}"
           .security = "${path.security}"
@@ -128,7 +129,6 @@ function endpointBodyTemplate(path) {
           server-url = "${path.servers && path.servers.length > 0 ? path.servers[0].url : this.selectedServer.computedUrl}" 
           active-schema-tab = "${this.defaultSchemaTab}"
           fill-request-fields-with-example = "${this.fillRequestFieldsWithExample}"
-          use-summary-to-list-example = "${this.useSummaryToListExamples}"
           allow-try = "${this.allowTry}"
           accept = "${accept}"
           render-style="${this.renderStyle}" 
@@ -136,8 +136,8 @@ function endpointBodyTemplate(path) {
           schema-expand-level = "${this.schemaExpandLevel}"
           schema-description-expanded = "${this.schemaDescriptionExpanded}"
           allow-schema-description-expand-toggle = "${this.allowSchemaDescriptionExpandToggle}"
-          schema-hide-read-only = "${path.isWebhook ? this.schemaHideWriteOnly : this.schemaHideReadOnly}"
-          schema-hide-write-only = "${path.isWebhook ? this.schemaHideReadOnly : this.schemaHideWriteOnly}"
+          schema-hide-read-only = "${this.schemaHideReadOnly === 'never' ? 'false' : path.isWebhook ? 'false' : 'true'}"
+          schema-hide-write-only = "${this.schemaHideWriteOnly === 'never' ? 'false' : path.isWebhook ? 'true' : 'false'}"
           fetch-credentials = "${this.fetchCredentials}"
           exportparts = "btn:btn, btn-fill:btn-fill, btn-outline:btn-outline, btn-try:btn-try, btn-clear:btn-clear, btn-clear-resp:btn-clear-resp,
             file-input:file-input, textbox:textbox, textbox-param:textbox-param, textarea:textarea, textarea-param:textarea-param, 
@@ -150,6 +150,7 @@ function endpointBodyTemplate(path) {
       <api-response
         class = "${this.renderStyle}-mode"
         style = "width:100%;"
+        webhook = "${path.isWebhook}"
         .responses="${path.responses}"
         active-schema-tab = "${this.defaultSchemaTab}" 
         render-style="${this.renderStyle}" 
@@ -157,8 +158,8 @@ function endpointBodyTemplate(path) {
         schema-expand-level = "${this.schemaExpandLevel}"
         schema-description-expanded = "${this.schemaDescriptionExpanded}"
         allow-schema-description-expand-toggle = "${this.allowSchemaDescriptionExpandToggle}"
-        schema-hide-read-only = "${path.isWebhook ? this.schemaHideWriteOnly : this.schemaHideReadOnly}"
-        schema-hide-write-only = "${path.isWebhook ? this.schemaHideReadOnly : this.schemaHideWriteOnly}"
+        schema-hide-read-only = "${this.schemaHideReadOnly === 'never' ? 'false' : path.isWebhook ? 'true' : 'false'}"
+        schema-hide-write-only = "${this.schemaHideWriteOnly === 'never' ? 'false' : path.isWebhook ? 'false' : 'true'}"
         selected-status = "${Object.keys(path.responses || {})[0] || ''}"
         exportparts = "btn:btn, btn-fill:btn-fill, btn-outline:btn-outline, btn-try:btn-try, file-input:file-input, 
         textbox:textbox, textbox-param:textbox-param, textarea:textarea, textarea-param:textarea-param, anchor:anchor, anchor-param-example:anchor-param-example, btn-clear-resp:btn-clear-resp,

package/src/templates/expanded-endpoint-template.js

@@ -70,6 +70,7 @@ export function expandedEndpointBodyTemplate(path, tagName = '') {
         <api-request
           class = "${this.renderStyle}-mode"
           style = "width:100%;"
+          webhook = "${path.isWebhook}"
           method = "${path.method}"
           path = "${path.path}"
           .security = "${path.security}"
@@ -79,7 +80,6 @@ export function expandedEndpointBodyTemplate(path, tagName = '') {
           .servers = "${path.servers}"
           server-url = "${path.servers?.[0]?.url || this.selectedServer.computedUrl}"
           fill-request-fields-with-example = "${this.fillRequestFieldsWithExample}"
-          use-summary-to-list-example = "${this.useSummaryToListExamples}"
           allow-try = "${this.allowTry}"
           accept = "${accept}"
           render-style="${this.renderStyle}" 
@@ -88,8 +88,8 @@ export function expandedEndpointBodyTemplate(path, tagName = '') {
           schema-expand-level = "${this.schemaExpandLevel}"
           schema-description-expanded = "${this.schemaDescriptionExpanded}"
           allow-schema-description-expand-toggle = "${this.allowSchemaDescriptionExpandToggle}"
-          schema-hide-read-only = "${path.isWebhook ? false : this.schemaHideReadOnly}"
-          schema-hide-write-only = "${path.isWebhook ? this.schemaHideWriteOnly : false}"
+          schema-hide-read-only = "${this.schemaHideReadOnly === 'never' ? 'false' : path.isWebhook ? 'false' : 'true'}"
+          schema-hide-write-only = "${this.schemaHideWriteOnly === 'never' ? 'false' : path.isWebhook ? 'true' : 'false'}"
           fetch-credentials = "${this.fetchCredentials}"
           exportparts = "btn:btn, btn-fill:btn-fill, btn-outline:btn-outline, btn-try:btn-try, btn-clear:btn-clear, btn-clear-resp:btn-clear-resp,
             file-input:file-input, textbox:textbox, textbox-param:textbox-param, textarea:textarea, textarea-param:textarea-param, 
@@ -101,6 +101,7 @@ export function expandedEndpointBodyTemplate(path, tagName = '') {
         <api-response
           class = "${this.renderStyle}-mode"
           style = "width:100%;"
+          webhook = "${path.isWebhook}"
           .responses = "${path.responses}"
           render-style = "${this.renderStyle}"
           schema-style = "${this.schemaStyle}"
@@ -108,8 +109,8 @@ export function expandedEndpointBodyTemplate(path, tagName = '') {
           schema-expand-level = "${this.schemaExpandLevel}"
           schema-description-expanded = "${this.schemaDescriptionExpanded}"
           allow-schema-description-expand-toggle = "${this.allowSchemaDescriptionExpandToggle}"
-          schema-hide-read-only = "${path.isWebhook ? this.schemaHideReadOnly : false}"
-          schema-hide-write-only = "${path.isWebhook ? false : this.schemaHideWriteOnly}"
+          schema-hide-read-only = "${this.schemaHideReadOnly === 'never' ? 'false' : path.isWebhook ? 'true' : 'false'}"
+          schema-hide-write-only = "${this.schemaHideWriteOnly === 'never' ? 'false' : path.isWebhook ? 'false' : 'true'}"
           selected-status = "${Object.keys(path.responses || {})[0] || ''}"
           exportparts = "btn:btn, btn-response-status:btn-response-status, btn-selected-response-status:btn-selected-response-status, btn-fill:btn-fill, btn-copy:btn-copy,
           schema-description:schema-description, schema-multiline-toggle:schema-multiline-toggle"

package/src/templates/navbar-template.js

@@ -50,7 +50,7 @@ export default function navbarTemplate() {
     ${(this.allowSearch === 'false' && this.allowAdvancedSearch === 'false')
       ? ''
       : html`
-        <div style="display:flex; flex-direction:row; justify-content:center; align-items:stretch; padding:8px 24px 12px 24px; ${this.allowAdvancedSearch === 'false' ? 'border-bottom: 1px solid var(--nav-hover-bg-color)' : ''}">
+        <div style="display:flex; flex-direction:row; justify-content:center; align-items:stretch; padding:8px 24px 12px 24px; ${this.allowAdvancedSearch === 'false' ? 'border-bottom: 1px solid var(--nav-hover-bg-color)' : ''}" part="section-navbar-search">
           ${this.allowSearch === 'false'
             ? ''
             : html`

package/src/utils/common-utils.js

@@ -124,6 +124,7 @@ export function advancedSearch(searchVal, allSpecTags, searchOptions = []) {
   return pathsMatched;
 }
 
+/*
 export function prettyXml(sourceXmlString) {
   const xmlDoc = new DOMParser().parseFromString(sourceXmlString, 'text/xml');
   const xsltDoc = new DOMParser().parseFromString([
@@ -144,10 +145,6 @@ export function prettyXml(sourceXmlString) {
   const resultDoc = xsltProcessor.transformToDocument(xmlDoc);
   return new XMLSerializer().serializeToString(resultDoc);
 }
-/*
-export function hasValidPathInUrlHash(tags) {
-  return tags.find((tag) => tag.paths.find((path) => window.location.hash.substring(1) === path.elementId));
-}
 */
 
 export function downloadResource(url, fileName) {

package/src/utils/schema-utils.js

@@ -81,48 +81,69 @@ export function getTypeInfo(schema) {
   return info;
 }
 export function nestExampleIfPresent(example) {
+  if (typeof example === 'boolean') {
+    return {
+      Example: { value: `${example}` },
+    };
+  }
+  if (example === '') {
+    return {
+      Example: { value: '' },
+    };
+  }
   return example ? { Example: { value: example } } : example;
 }
+
 export function normalizeExamples(examples, dataType = 'string') {
-  let exampleVal;
-  let exampleList;
-  if (examples) {
-    if (examples.constructor === Object) {
-      const exampleValAndDescr = Object.values(examples);
-      exampleVal = exampleValAndDescr.length > 0
-        ? typeof exampleValAndDescr[0].value === 'boolean' || typeof exampleValAndDescr[0].value === 'number'
-          ? exampleValAndDescr[0].value.toString()
-          : exampleValAndDescr[0].value
-        : '';
-      exampleList = Object.values(examples).map((v) => ({
-        value: typeof v.value === 'boolean' || typeof v.value === 'number' ? v.value.toString() : v.value,
-        description: v.description || v.summary || v.value,
-      }));
-    } else {
-      // This is non standard way to provide example but will support for now
-      if (!Array.isArray(examples)) {
-        examples = examples ? [examples] : [];
-      }
-      if (examples.length > 0) {
-        if (dataType === 'array') {
-          [exampleVal] = examples;
-          exampleList = examples.map((v) => ({ value: v, description: Array.isArray(v) ? v.join(' , ') : v }));
-        } else {
-          exampleVal = examples[0].toString();
-          exampleList = examples.map((v) => ({ value: v.toString(), description: v }));
-        }
-      }
-    }
+  if (!examples) {
     return {
-      exampleVal,
-      exampleList,
+      exampleVal: '',
+      exampleList: [],
     };
   }
-  return {
-    exampleVal: '',
-    exampleList: [],
-  };
+
+  if (examples.constructor === Object) {
+    const exampleValAndDescr = Object.values(examples);
+    const exampleVal = exampleValAndDescr.length > 0
+      ? typeof exampleValAndDescr[0].value === 'boolean' || typeof exampleValAndDescr[0].value === 'number'
+        ? exampleValAndDescr[0].value.toString()
+        : exampleValAndDescr[0].value
+      : '';
+    const exampleList = Object.values(examples).map((v) => ({
+      value: typeof v.value === 'boolean' || typeof v.value === 'number' ? v.value.toString() : v.value,
+      summary: v.summary,
+      description: v.description,
+    }));
+    return { exampleVal, exampleList };
+  }
+
+  // This is non-standard way to provide example but will support for now
+  if (!Array.isArray(examples)) {
+    examples = examples ? [examples] : [];
+  }
+
+  if (examples.length === 0) {
+    return {
+      exampleVal: '',
+      exampleList: [],
+    };
+  }
+
+  if (dataType === 'array') {
+    const [exampleVal] = examples;
+    const exampleList = examples.map((v) => ({ value: v }));
+    return { exampleVal, exampleList };
+  }
+
+  const exampleVal = examples[0].toString();
+  const exampleList = examples.map((v) => ({ value: v.toString() }));
+  return { exampleVal, exampleList };
+}
+
+export function anyExampleWithSummaryOrDescription(examples) {
+  return examples.some((x) => x.summary?.length > 0 || x.description?.length > 0);
 }
+
 export function getSampleValueByType(schemaObj) {
   const example = schemaObj.examples
     ? schemaObj.examples[0]
@@ -664,6 +685,9 @@ export function schemaInObjectNotation(schema, obj, level = 0, suffix = '') {
     obj['::title'] = schema.title || '';
     obj['::description'] = generateMarkdownForArrayAndObjectDescription(schema, level);
     obj['::type'] = 'object';
+    if ((Array.isArray(schema.type) && schema.type.includes('null')) || schema.nullable) {
+      obj['::dataTypeLabel'] = 'object or null';
+    }
     obj['::deprecated'] = schema.deprecated || false;
     obj['::readwrite'] = schema.readOnly ? 'readonly' : schema.writeOnly ? 'writeonly' : '';
     for (const key in schema.properties) {
@@ -680,6 +704,9 @@ export function schemaInObjectNotation(schema, obj, level = 0, suffix = '') {
     obj['::title'] = schema.title || '';
     obj['::description'] = generateMarkdownForArrayAndObjectDescription(schema, level);
     obj['::type'] = 'array';
+    if ((Array.isArray(schema.type) && schema.type.includes('null')) || schema.nullable) {
+      obj['::dataTypeLabel'] = 'array or null';
+    }
     obj['::deprecated'] = schema.deprecated || false;
     obj['::readwrite'] = schema.readOnly ? 'readonly' : schema.writeOnly ? 'writeonly' : '';
     if (schema.items?.items) {

package/src/utils/theme.js

@@ -206,8 +206,8 @@ export default function setTheme(baseTheme, theme = {}) {
       : '7px 16px 7px 10px')};
     
     --resp-area-height: ${this.responseAreaHeight};
-    --font-size-small:  ${this.fontSize === 'default' ? '12px' : (this.fontSize === 'large' ? '13px' : '14px')};
-    --font-size-mono:   ${this.fontSize === 'default' ? '13px' : (this.fontSize === 'large' ? '14px' : '15px')};
+    --font-size-small: ${this.fontSize === 'default' ? '12px' : (this.fontSize === 'large' ? '13px' : '14px')};
+    --font-size-mono: ${this.fontSize === 'default' ? '13px' : (this.fontSize === 'large' ? '14px' : '15px')};
     --font-size-regular: ${this.fontSize === 'default' ? '14px' : (this.fontSize === 'large' ? '15px' : '16px')};
     --dialog-z-index: 1000;