rapidoc 9.1.0 → 9.1.4

package/docs/rapidoc-mini.html

@@ -27,11 +27,11 @@
     <main>
       <h2>Introducing &lt;rapi-doc-mini&gt; Web Component </h2>
       <p> 
-        <b>&lt;rapi-doc-mini&gt;</b> a new way to expose your API documentation. There are various styles and need how one would like to document their APIs. 
+        <b>&lt;rapi-doc-mini&gt;</b> a new way to expose your API documentation. There are various styles and needs how one would like to document their APIs. 
         such as 
         <ul>
           <li>
-            All the APIs are documented in one central place. This is where <b>&lt;rapi-doc&gt;</b> fits in.
+            All the APIs are documented in one central place. This is where <b>&lt;rapi-doc&gt;</b> fits in. However for the rest of bullets listed below  <b>&lt;rapi-doc-mini&gt;</b> is your friend
           </li>
           <li>
            Expose just a few important APIs such as authentication etc as a part of a blog, to provide an initial understanding to your audience
@@ -41,13 +41,12 @@
           </li>
           <li>
             Or you are explaining a business case which uses microservices, 
-            where each microservice has its own APIs and the ask is to pick few APIs from each of theses microservice show how they come work together in a single document
+            where each microservice has its own APIs and the ask is to pick few APIs from each of theses microservice show how they work together in a single document
           </li>
         </ul>
       </p>
 
-
-      <h2>Usage in a bolg style writing</h2>
+      <h2>Usage in a blog style writing</h2>
       <p style="flex:1">
         It is fairly common to write specifically about few APIs to provide an initial understanding to your users. 
         However in those cases you run the risk of your writeup getting outdated when the actual API changes its shape.
@@ -69,11 +68,12 @@
               bg-color = "#f9f9fb"
             &gt; &lt;/rapi-doc-mini&gt;</code>
         </pre>
-        Above HTML snippet will result in generating an API doc as shown below. Go ahead and play with the below APIs, make live request and watch the responses
+        Above HTML snippet will result in generating an API doc as shown below. Notice how it blends seamlessly with this writeup as if its a part of this page. 
+        Go ahead and play with the below APIs, make live request and watch the responses, all from this very blog.
       </p>
       <rapi-doc-mini
         style= "min-width:600px;"
-        spec-url="../specs/mock.yaml"
+        spec-url="./specs/mock.yaml"
         theme = "light"
         paths-expanded = "false"
         bg-color = "#f9f9fb"
@@ -87,7 +87,7 @@
       <br/><br/>
       <rapi-doc-mini
         style = "width:600px;border-radius: 4px; border: 2px solid #333; box-shadow: 0 3px 6px rgba(0,0,0,0.16), 0 3px 6px rgba(0,0,0,0.23);"
-        spec-url="../specs/mock.yaml"
+        spec-url="./specs/mock.yaml"
         theme = "light"
         schema-style = 'table'
         sort-endpoints-by = "method"
@@ -95,9 +95,8 @@
         paths-expanded = "false"
       > </rapi-doc-mini>
      
-     
       <br/><br/>
-      <h3>Pick and show specific APIs </h3>
+      <h3>Pick only specific APIs from OpenAPI spec</h3>
       Instead of showing entire open-api spec you can just extract and choose to show what you need to show. This is done using <b>match-paths</b> attribute.
       <br/>Example below uses the same OpenAPI spec as we used above, but showing only the paths that we intend to
 
@@ -115,7 +114,7 @@
       <br/> 
       <rapi-doc-mini
         style= "min-width:600px; width:600px; border-radius:2px; border: 1px solid #eee; border-top-width:0"
-        spec-url="../specs/mock.yaml"
+        spec-url="./specs/mock.yaml"
         theme = "light"
         schema-style = 'table'
         sort-endpoints-by = "method"
@@ -125,11 +124,12 @@
       > </rapi-doc-mini>
     <br/>
     <h3>More complex RegEx based filtering of API is possible too (match-paths & match-type)</h3>
+    Here we are using regular RegEx to select the paths which is either <span class="mono blue"> get /users/{userId}</span> &nbsp;&nbsp;or&nbsp;&nbsp; <span class="mono blue"> post /users</span>
     <pre class="shadow1 code-block" style="width:575px">
       <code class="language-html">
         &lt;rapi-doc-mini
           style= "min-width:600px;border: 1px solid #eee; border-top-width:0"
-          spec-url="../specs/mock.yaml"
+          spec-url="./specs/mock.yaml"
           theme = "light"
           paths-expanded = "false"
           match-paths = "^get /users/\{userId\}$|^post /users$"
@@ -141,7 +141,7 @@
     <br/> 
     <rapi-doc-mini
       style= "min-width:600px; width:600px; border-radius:2px; border: 1px solid #eee; border-top-width:0"
-      spec-url="../specs/mock.yaml"
+      spec-url="./specs/mock.yaml"
       theme = "light"
       schema-style = 'table'
       sort-endpoints-by = "method"
@@ -152,12 +152,12 @@
     > </rapi-doc-mini>
 
     <h3>Show it Minimzed or Expanded</h3>
-    If expand/collapse is not your style, or feel it a bit of distraction then have it always expanded and make it more natural and integrated part of your writeup.
+    If expand/collapse is not your style, then have it always expanded and make it more natural and integrated part of your writeup.
     <br> Use the attribute <b>paths-expanded = "true"</b> to achive this <br/><br/>
     
     <rapi-doc-mini
       style= "min-width:600px; width:600px;"
-      spec-url="../specs/mock.yaml"
+      spec-url="./specs/mock.yaml"
       theme = "light"
       schema-style = 'table'
       sort-endpoints-by = "method"
@@ -179,7 +179,7 @@
   <rapi-doc-mini
     style= "width:600px; border-radius: 4px; border: 1px solid #333"
     id = "thedoc" 
-    spec-url="../specs/code-highlight.yaml"
+    spec-url="./specs/code-highlight.yaml"
     theme = "light"
     schema-style = 'table'
     sort-endpoints-by = "method"
@@ -191,7 +191,7 @@
   <rapi-doc-mini
     style= "width:600px; border-radius: 4px; box-shadow: 0 3px 6px rgba(0,0,0,0.16), 0 3px 6px rgba(0,0,0,0.23);"
     id = "thedoc" 
-    spec-url="../specs/petstore.json"
+    spec-url="./specs/petstore.json"
     theme = "dark"
     schema-style = 'table'
     sort-endpoints-by = "method"
@@ -204,16 +204,16 @@
     style= "width:600px; border-radius: 4px; margin-bottom: 16px;"
     theme = "dark"
     id = "thedoc" 
-    spec-url="../specs/fake-non-existing.json"
+    spec-url="./specs/fake-non-existing.json"
   > </rapi-doc-mini>
   <rapi-doc-mini
     style= "width:600px; border-radius: 4px; margin-bottom: 16px;"
     theme = "light"
     id = "thedoc" 
-    spec-url="../specs/fake-non-existing.json"
+    spec-url="./specs/fake-non-existing.json"
   > </rapi-doc-mini>
 
 </main>
 
   </body>
-</html>
+</html>

package/docs/specs/auth-test1.yaml

@@ -0,0 +1,35 @@
+openapi: 3.0.1
+info:
+  title: Authentication Test Case
+  description: Demonstrate various authentication methods supported by RapiDoc
+servers:
+  - url: https://reqres.in/api/
+paths:
+  /users/{userId}:
+    get:
+      description: Uses HTTP Basic Auth
+      parameters:
+        - in: path
+          name: userId
+          schema:
+            type: integer
+            example: 3
+          required: true
+          description: Numeric ID of the user to get
+      security:
+      - http-basic: []
+
+  /users:
+    get:
+      description: Uses API Key Auth
+      security:
+      - api_key1: []
+components:
+  securitySchemes:
+    http-basic:
+      type: http
+      scheme: basic
+    api_key1:
+      type: apiKey
+      name: Authorization
+      in: header

package/docs/specs/auth.yaml

@@ -48,9 +48,9 @@ paths:
       - ms-oauth:
         - User.ReadBasic.All
         - Directory.Read.All
-      - http-basic: []
+      - http-basic: ['h-scope1', 'h-scope2']
       - api_key_cookie: []
-      - api_key1: []
+      - api_key1: ['a-scope1', 'a-scope2']
         api_key2: []
 components:
   securitySchemes:

package/docs/specs/code-highlight.yaml

@@ -60,7 +60,7 @@ info:
 
     <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>

package/docs/specs/data-types.yaml

@@ -220,7 +220,6 @@ components:
     id:
       type: string
       format: uuid
-      readOnly: true
     person:
       type: object
       required:

package/docs/specs/dynamic-query-params.yaml

@@ -75,6 +75,25 @@ paths:
                               type: string
                           additionalProperties:
                           type: string
+                  - in: query
+                    name: dynamic-query-params5
+                    explode: false
+                    required: false
+                    schema:
+                      type: object
+                      properties:
+                        propertyOne:
+                          type: string
+                          enum:
+                            - VALUE-1
+                            - VALUE-2
+                          default: VALUE-2
+                        propertyTwo:
+                          type: string
+                          enum:
+                            - FLAG-1
+                            - FLAG-2
+                          default: FLAG-1
                 responses:
                   '200':
                     description: successful operation
@@ -187,6 +206,28 @@ paths:
                     type: string
                 additionalProperties:
                   type: string
+        - in: query
+          name: dynamic-query-params5
+          description: >
+            Example generation works for non-exloded objects:<br />
+            `propertyOne=VALUE-1&property2=FLAG-1`
+          explode: false
+          required: false
+          schema:
+            type: object
+            properties:
+              propertyOne:
+                type: string
+                enum:
+                  - VALUE-1
+                  - VALUE-2
+                default: VALUE-2
+              propertyTwo:
+                type: string
+                enum:
+                  - FLAG-1
+                  - FLAG-2
+                default: FLAG-1
       responses:
         '200':
           description: successful operation

package/docs/specs/examples.yaml

@@ -60,6 +60,17 @@ paths:
             value: "unmarried"
           example3:
             value: "widowed"
+      - name: luckyNumbers
+        in: query
+        schema:
+          type: array
+          items:
+            type: number
+          minItems: 4
+          maxItems: 4
+          examples:
+            - [10]
+            - [10, 20, 30, 40]
 
   /multiple-examples-by-response-type:
     get:

package/docs/specs/mongo.yaml

@@ -0,0 +1,78 @@
+jsonSchemaViewer: 1.0.0
+info:
+  title: Database Schema
+schemaAndExamples:
+  users1:
+    description: Optionally may provide some Description about the schema. Can contain `markdown` syntax
+    schema:
+      $ref: '#/components/schemas/users'
+    examples:
+      - valid-json:
+        summary: Example with Valid JSON String
+        description: If valid JSON is provided in the example, It will be displayed in JSON tree form. Allowing copy/expand/collapse functionality
+        value: |
+          {
+            "person": {
+              "fullName": {
+                "firstName": "Mickey",
+                "lastName": "Mouse"
+              },
+              "age": "9"
+            }
+          }
+      - invalid-json:
+        summary: Example with Invalid JSON String
+        description: Invalid JSON is displayed in text-area as is
+        value: |
+          {
+            person: {
+              fullName: {
+                firstName: Donald,
+                lastName: Duck
+              },
+              age: 10
+            }
+          }
+      - as-object:
+        summary: Example specified as object
+        value:
+          fullName:
+            firstName: Donald
+            lastName: Duck       
+          age: 10
+  users2:
+    schema:
+      $ref: '#/components/schemas/users'
+
+components:
+  schemas:
+    users:
+      type: object
+      properties:
+        id:
+          description: User ID
+          type: integer
+        email:
+          description: User Email
+          type: string
+        first_name:
+          description: First Name
+          type: string
+        last_name:
+          description: Last Name
+          type: string
+        avatar:
+          description: Avatar URL
+          type: string
+    tenants:
+      type: object
+      properties:
+        url:
+          description: Support URL
+          type: string
+        text:
+          description: Support URL - Description
+          type: string
+    external:      
+      $ref: '../specs/tenants.json'
+

package/docs/specs/multipart-formdata.yaml

@@ -11,6 +11,8 @@ paths:
           multipart/form-data:
             schema:
               type: object
+              required:
+                - agePart
               properties:
                 photoPart:
                   type: string
@@ -27,6 +29,7 @@ paths:
                 agePart:
                   type: integer
                   default: 21
+                  deprecated: true
                   description: 'Age of the person'
                 contactPart:
                   type: object

package/docs/specs/petstore_extended.yaml

@@ -69,7 +69,7 @@ info:
       <!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>

package/docs/specs/readwrite.yaml

@@ -0,0 +1,90 @@
+openapi: 3.0.3
+info:
+  version: "1.0.0"
+  title: "RaedOnly and WriteOnly Testcase "
+paths:
+  /read-write:
+    post:
+      summary: "Request doesn't show the read-only and Response doesn't show write-only"
+      requestBody:
+        content:
+          application/json:
+            schema:
+              properties:
+                holder:
+                  $ref: '#/components/schemas/Holder'
+      responses:
+        '200':
+          description: Successful operation
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/Holder'
+
+components:
+  schemas:
+    Holder:
+      type: object
+      properties:
+        id:
+          type: integer
+        name:
+          type: string
+        others:
+          $ref: '#/components/schemas/other'
+    other:
+      type: object
+      required:
+        - obj-regular
+      properties:
+        primitive:
+          type: integer
+        primitive-readonly:
+          readOnly: true
+          type: integer
+        obj-regular:
+          type: object
+          properties:
+            obj-prop1:
+              type: integer
+            obj-prop2:
+              type: integer
+            obj-prop-readonly:
+              readOnly: true
+              type: integer
+            obj-prop-writeonly:
+              writeOnly: true
+              type: integer
+        primitive-writeonly:
+          writeOnly: true
+          type: integer
+        obj-readonly:
+          type: object
+          readOnly: true
+          properties:
+            c1:
+              type: integer
+            c2:
+              type: integer
+        obj-writeonly:
+          type: object
+          writeOnly: true
+          properties:
+            d1:
+              type: integer
+            d2:
+              type: integer
+        arr-readonly:
+          type: array
+          readOnly: true
+          items:
+            type: string
+        arr-writeonly:
+          type: array
+          writeOnly: true
+          items:
+            type: string
+        g:
+          type: integer

package/docs/specs/server.yaml

@@ -1,7 +1,7 @@
 openapi: 3.0.2
 info:
   version: '1.0'
-  title: Server Variables
+  title: API Server templating using variables
   description: >
     Various ways to define API servers in the spec including variables
 
@@ -84,10 +84,10 @@ servers:
           - v1
           - v2
 paths:
-  /server-variables:
+  /api-server-template:
     get:
-      summary: Server Variable.
-      discription: Computed server url should be shown against `API SERVER`.
+      summary: Dynamic API Server.
+      description: Uses API server template string and variables which can be used to generatea a desired API server url -  The selected and computed API Server URL should be shown against `API SERVER`.
       responses:
         '200':
           description: successful operation

package/docs/specs/temp.json

@@ -1,115 +1,34 @@
 {
-  "openapi": "3.0.0",
+  "components": {},
   "info": {
-    "title": "photos API",
-    "description": "picsum",
-    "version": "1.0.0"
+      "title": "Example Schema",
+      "version": "0.0.1"
   },
-  "servers": [
-    {
-      "url": "https://picsum.photos/",
-      "description": "picsum photos"
-    }
-  ],
+  "openapi": "3.0.3",
   "paths": {
-    "/{width}/{height}": {
-      "get": {
-        "tags": [
-          "The Lorem Ipsum for photos"
-        ],
-        "description": "Return a photo",
-        "parameters": [
-          {
-            "name": "width",
-            "in": "path",
-            "description": "photo width",
-            "required": true,
-            "example": 100,
-            "schema": {
-              "minimum": 100,
-              "type": "integer",
-              "format": "int32"
-            }
-          },
-          {
-            "name": "height",
-            "in": "path",
-            "description": "photo height",
-            "required": true,
-            "example": 100,
-            "schema": {
-              "minimum": 100,
-              "type": "integer",
-              "format": "int32"
-            }
-          }
-        ],
-        "responses": {
-          "200": {
-            "description": "Default response",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "type": "object",
-                  "properties": {
-                    "data": {
-                      "type": "object",
-                      "properties": {
-                        "attributes": {
-                          "type": "object",
-                          "properties": {
-                            "randomId": {
-                              "type": "integer"
-                            }
-                          },
-                          "anyOf": [
-                            {
-                              "oneOf": [
-                                {
-                                  "properties": {
-                                    "title1": {
-                                      "type": "string"
-                                    }
-                                  }
-                                },
-                                {
-                                  "properties": {
-                                    "examId1": {
-                                      "type": "integer"
-                                    }
-                                  }
-                                }
-                              ]
-                            },
-                            {
-                              "oneOf": [
-                                {
-                                  "properties": {
-                                    "title2": {
-                                      "type": "string"
-                                    }
-                                  }
-                                },
-                                {
-                                  "properties": {
-                                    "examId2": {
-                                      "type": "integer"
-                                    }
-                                  }
-                                }
-                              ]
-                            }
-                          ]
-                        }
+      "/api/v1/example": {
+          "get": {
+              "operationId": "v1_example",
+              "description": "Example API",
+              "parameters": [
+                  {
+                      "in": "query",
+                      "name": "boolean_query_parameter",
+                      "schema": {
+                          "type": "boolean",
+                          "default": false
+                      }
+                  },
+                  {
+                      "in": "query",
+                      "name": "integer_query_parameter",
+                      "schema": {
+                          "type": "integer",
+                          "default": 0
                       }
-                    }
                   }
-                }
-              }
-            }
+              ]
           }
-        }
       }
-    }
   }
 }