Merge pull request mrin9#24 from soulsnake/SortTagsOption

Sort tags option

Author: mrin9

docs/index.html

@@ -197,6 +197,12 @@ <h2> Attributes</h2>
               <td>false</td>
             </tr>
 
+            <tr>
+              <td class="mono-bold">pdf-sort-tags</td>
+              <td class="gray"> true to sort tags in the generated PDF</td>
+              <td>true</td>
+            </tr>
+
             <tr>
               <td class="mono-bold">pdf-primary-color</td>
               <td class="gray">Color used for headings of main sections in PDF</td>

src/rapipdf.js

@@ -193,6 +193,7 @@ export default customElements.define('rapi-pdf', class RapiPdf extends HTMLEleme
   }
 
   generatePdf(jsonObj){
+    let pdfSortTags       = this.getAttribute('pdf-sort-tags')==='false'?false:true;
     let pdfPrimaryColor   = this.getAttribute('pdf-primary-color');
     let pdfAlternateColor = this.getAttribute('pdf-alternate-color');
     let pdfTitle          = this.getAttribute('pdf-title')===null?'API Reference':this.getAttribute('pdf-title');
@@ -208,6 +209,7 @@ export default customElements.define('rapi-pdf', class RapiPdf extends HTMLEleme
 
     let localize = this.localize;
     let options = {
+      pdfSortTags,
       pdfPrimaryColor,
       pdfAlternateColor,
       pdfTitle,

src/utils/parse-utils.js

@@ -1,7 +1,7 @@
 import JsonRefs from 'json-refs';
 import converter from 'swagger2openapi';
 
-export default async function ProcessSpec(specUrl) {
+export default async function ProcessSpec(specUrl, sortTags) {
   let jsonParsedSpec, convertedSpec, resolvedRefSpec;
   let convertOptions = { patch:true, warnOnly:true };
   let resolveOptions = { resolveCirculars: false }
@@ -148,7 +148,9 @@ export default async function ProcessSpec(specUrl) {
     })
   }
   servers = openApiSpec.servers;
-  tags.sort((a, b) =>  (a.name < b.name ? -1 : (a.name > b.name ? 1: 0)) );
+  if (sortTags) {
+    tags.sort((a, b) =>  (a.name < b.name ? -1 : (a.name > b.name ? 1: 0)) );
+  }
   let parsedSpec = {
     "info"    : openApiSpec.info,
     "tags"    : tags,

src/utils/pdf-gen.js

@@ -7,7 +7,7 @@ import { getInfoDef, getSecurityDef, getApiDef, getApiListDef, getMarkDownDef }
 
 export default async function createPdf(specUrl, options){
 
-  let parsedSpec = await ProcessSpec(specUrl);
+  let parsedSpec = await ProcessSpec(specUrl, options.pdfSortTags);
 
   let pdfStyles={
     title:{fontSize:32},