rapidoc 9.1.3 → 9.1.4

package/docker/Dockerfile

@@ -1,3 +1,6 @@
+# to Build the Docker image from root folder execute 
+# docker build -t mrin9/rapidoc -f ./docker/Dockerfile . 
+
 # Run the Docker image (view a spec thats hosted on a web-server)
 # docker run -it --rm -p 80:80 -e SPEC_URL="http://petstore.swagger.io/v2/swagger.json" mrin9/rapidoc
 
@@ -30,17 +33,14 @@ RUN npm run build
 
 # production stage
 FROM nginx:stable-alpine as production-stage
-COPY --from=build-stage /app/dist /app
-COPY ./nginx/nginx.conf /etc/nginx/nginx.conf
 
 ENV PAGE_TITLE="RapiDoc"
 ENV PAGE_FAVICON="favicon.png"
 ENV SPEC_URL="http://petstore.swagger.io/v2/swagger.json"
 ENV PORT=80
-ENV RAPIDOC_OPTIONS=
 
 # copy files to the nginx folder
-COPY --from=0 build/dist /usr/share/nginx/html
+COPY --from=build-stage /app/dist /usr/share/nginx/html
 COPY docker/index.tpl.html /usr/share/nginx/html/index.html
 COPY logo.png /usr/share/nginx/html/favicon.png
 COPY docker/nginx.conf /etc/nginx/
@@ -48,4 +48,4 @@ COPY docker/docker-run.sh /usr/local/bin
 
 EXPOSE 80
 
-CMD ["sh", "/usr/local/bin/docker-run.sh"]
+CMD ["sh", "/usr/local/bin/docker-run.sh"]

package/docs/api.html

@@ -14,8 +14,8 @@
 
   <meta charset="utf-8">
   <meta name="viewport" content="width=device-width, minimum-scale=1, initial-scale=1, user-scalable=yes">
-  <meta name="description" content="RapiDoc is Web Component for viewing Swagger & OpenAPI Spec. Supports themes, styling and various rendering styles">
-  <meta name="keywords" content="RapiDoc, ReDoc, Swagger, SwaggerUI, Custom Element, Web Component, OpenAPI,REST, themes, dark mode, markdown, API documentation">
+  <meta name="description" content="RapiDoc is a Web Component for viewing Swagger & OpenAPI Spec. Supports themes, styling and various rendering styles">
+  <meta name="keywords" content="RapiDoc, openapi viewer, openapi to html, openapi renderer, ReDoc, Swagger, SwaggerUI, Custom Element, Web Component, OpenAPI, REST, themes, dark mode, markdown, API documentation">
 
   <link rel="shortcut icon" type="image/png" href="./images/logo.png"/>
 
@@ -147,6 +147,13 @@
             </span> Request fields will be filled with example value (if provided in spec) </td>
             <td class='default-col'>true</td>
           </tr>
+
+          <tr>
+            <td class="attr-col mono bold right">persist-auth </td>
+            <td class="gray"><span class='bold dark-gray'>Allowed:<span class='blue'> true | false </span>
+            </span> Authentication will be persisted to localStorage </td>
+            <td class='default-col'>false</td>
+          </tr>
         </table>
 
         <a id="att-colors"></a>
@@ -352,7 +359,7 @@
           <tr>
             <td class="mono bold right">schema-hide-read-only </td>
             <td class="gray"> <span class='bold dark-gray'>Allowed:<span class='blue'> always | never | (combination of: post | put | patch)</span></span> -
-              read-only fileds in request schemas is <span class='blue'> always </span> hidden but are shown in response.
+              read-only fields in request schemas is <span class='blue'> always </span> hidden but are shown in response.
               <br/>
               If you do not want to hide read-only fields or hide them based on action you can configure this setting to 'never' or any combination of post | put | patch to indicate where to hide
               <br/>
@@ -364,7 +371,7 @@
           <tr>
             <td class="mono bold right">schema-hide-write-only </td>
             <td class="gray"> <span class='bold dark-gray'>Allowed:<span class='blue'> always | never</span></span> -
-              write-only fileds in response schemas is <span class='blue'> always </span> hidden but are shown in request.
+              write-only fields in response schemas is <span class='blue'> always </span> hidden but are shown in request.
               <br/>
               If you do not want to hide write-only fields then set to 'never'
               <br/>
@@ -797,7 +804,7 @@
             <tr>
               <td class="mono bold right">{method}-{path}</td>
               <td class="gray"> each path is identified by an id. which is in the format of {method}-{path},
-                and certain invalid charecters such as {, }, #, space is replaced by hyphen (-).
+                and certain invalid characters such as {, }, #, space is replaced by hyphen (-).
                 Use this slot to insert HTML content into a specifi tag
               </td>
             </tr>

package/docs/examples/dynamic-query-params.html

@@ -29,6 +29,7 @@
       show-header = "false"
       regular-font = 'Open Sans'
       mono-font = "Roboto Mono"
+      default-schema-tab = "example"
     > </rapi-doc>
   </body>
 </html>

package/docs/examples/readwrite.html

@@ -0,0 +1,40 @@
+<!doctype html>
+<html>
+  <head>
+    <!-- Global site tag (gtag.js) - Google Analytics -->
+    <script async src='https://www.googletagmanager.com/gtag/js?id=UA-132775238-1'></script>
+    <script>
+      window.dataLayer = window.dataLayer || [];
+      function gtag(){dataLayer.push(arguments);}
+      gtag('js', new Date());
+      gtag('config', 'UA-132775238-1');
+    </script>
+    <meta charset='utf-8'>
+    <meta name='viewport' content='width=device-width, minimum-scale=1, initial-scale=1, user-scalable=yes'>
+    <link href="https://fonts.googleapis.com/css2?family=Open+Sans:wght@300;600&family=Roboto+Mono&display=swap" rel="stylesheet">
+    <link href='../index.css' rel='stylesheet'>
+    <script type='module' src='../rapidoc-min.js'></script>
+  </head>
+  <body>
+    <rapi-doc spec-url="../specs/readwrite.yaml"
+      id = "thedoc"
+      allow-authentication = "false" 
+      allow-search = "false"
+      show-info = "false"
+      show-header = "false"
+      render-style = "read"
+      allow-try = "false" 
+      regular-font = 'Open Sans'
+      mono-font = "Roboto Mono"
+      theme = "dark"
+      schema-style='tree'
+    > 
+      <div slot="nav-logo" style="width:100%; display: flex; flex-direction:column;">
+        <div style="display: flex;justify-content: center; margin: 2px 0">
+          <button class='btn medium' onclick="document.getElementById('thedoc').setAttribute('schema-style', 'tree')" >Tree</button>
+          <button class='btn medium' onclick="document.getElementById('thedoc').setAttribute('schema-style', 'table')" >Table</button>
+        </div>
+      </div>
+  </rapi-doc>
+  </body>
+</html>

package/docs/examples.html

@@ -77,7 +77,7 @@
         <!doctype html> <!-- Important: must specify -->
         <html>
           <head>
-            <meta charset="utf-8"> <!-- Important: rapi-doc uses utf8 charecters -->
+            <meta charset="utf-8"> <!-- Important: rapi-doc uses utf8 characters -->
             <script type="module" src="https://unpkg.com/rapidoc/dist/rapidoc-min.js"></script>
           </head>
           <body>
@@ -188,7 +188,8 @@
         <img 
           slot="nav-logo" 
           src="https://img.icons8.com/color/48/000000/youtube-play.png"
-        /> 
+        />
+      />  
       </rapi-doc>
     </code>
   </pre>

package/docs/index.html

@@ -15,7 +15,7 @@
   <meta charset="utf-8">
   <meta name="viewport" content="width=device-width, minimum-scale=1, initial-scale=1, user-scalable=yes">
   <meta name="description" content="RapiDoc is Web Component for viewing Swagger & OpenAPI Spec. Supports themes, styling and various rendering styles">
-  <meta name="keywords" content="API, RapiDoc, ReDoc, stoplight, readme, Swagger, SwaggerUI, Custom Element, async-api, Web Component, web-hooks, OpenAPI, REST, themes, dark mode, markdown, API documentation, open api console, API mock, rest documentation">
+  <meta name="keywords" content="RapiDoc, openapi viewer, openapi to html, openapi renderer, ReDoc, Swagger, SwaggerUI, Custom Element, Web Component, OpenAPI, REST, themes, dark mode, markdown, API documentation, API mock">
 
   <link rel="shortcut icon" type="image/png" href="./images/logo.png"/>
 
@@ -267,7 +267,7 @@
         &lt;!doctype html&gt; &lt;!-- Important: must specify --&gt;
         &lt;html&gt;
         &lt;head&gt;
-          &lt;meta charset="utf-8"&gt; &lt;!-- Important: rapi-doc uses utf8 charecters --&gt;
+          &lt;meta charset="utf-8"&gt; &lt;!-- Important: rapi-doc uses utf8 characters --&gt;
           &lt;script type="module" src="https://unpkg.com/rapidoc/dist/rapidoc-min.js"&gt;&lt;/script&gt;
         &lt;/head&gt;
         &lt;body&gt;

package/docs/list.html

@@ -14,7 +14,7 @@
   <meta charset="utf-8">
   <meta name="viewport" content="width=device-width, minimum-scale=1, initial-scale=1, user-scalable=yes">
   <meta name="description" content="RapiDoc is Web Component for viewing Swagger & OpenAPI Spec. Supports themes, styling and various rendering styles">
-  <meta name="keywords" content="RapiDoc, ReDoc, Swagger, SwaggerUI, Custom Element, async-api, Web Component, web-hooks, OpenAPI, REST, themes, dark mode, markdown, API documentation">
+  <meta name="keywords" content="RapiDoc, openapi viewer, openapi to html, openapi renderer, ReDoc, Swagger, SwaggerUI, Custom Element, Web Component, OpenAPI, REST, themes, dark mode, markdown, API documentation">
 
   <link rel="shortcut icon" type="image/png" href="./images/logo.png"/>
 
@@ -509,7 +509,11 @@
       <tr><td class="mono-bold">
         <a href="./examples/data-types.html"> Data types </a>
       </td></tr>
-      
+
+      <tr><td class="mono-bold">
+        <a href="./examples/readwrite.html"> Read and Write annotations </a>
+      </td></tr>
+
       <tr><td class="mono-bold">
         <a href="./examples/example-with-nested-refs.html"> Provide Examples with nested refs </a>
       </td></tr>

package/docs/quickstart.html

@@ -87,7 +87,7 @@
         <!doctype html> <!-- Important: must specify -->
         <html>
           <head>
-            <meta charset="utf-8"> <!-- Important: rapi-doc uses utf8 charecters -->
+            <meta charset="utf-8"> <!-- Important: rapi-doc uses utf8 characters -->
             <script type="module" src="https://unpkg.com/rapidoc/dist/rapidoc-min.js"></script>
           </head>
           <body>