rapidoc 9.1.0 → 9.1.4

package/docs/specs/temp.yaml

@@ -1,298 +1,36 @@
 openapi: 3.0.0
 info:
-  description: Contains all data types
+  title: all-of Models
+  description: Model composition using all-of
   version: 1.0.0
-  title: Testing different data-types
 paths:
-  /nested-object-in-request-body:
-    post:
-      tags:
-        - Test with various data types
-      summary: Request Body accepting a JSON
-      requestBody:
-        content:
-          application/json:
-            schema:
-              $ref: "#/components/schemas/person"
-  /nested-object:
+  /all-of/employee:
     get:
-      tags:
-        - Test with various data types
-      summary: Nested object
-      description: Response schema is made up of multiple nested object, For simple schema check out [simple object](#get-/simple-object)
+      summary: List of employees
       responses:
-        '200':
-          description: successful operation
+        "200":
           content:
             application/json:
               schema:
                 type: object
-                description: Description of **Person** object (Person must be bold)
-                properties:
-                  age:
-                    description: Person's **Age** (age must be bold)
-                    type: integer
-                  fullName:
-                    description: Person's Full name
-                    type: object
-                    properties:
-                      firstName:
-                        description: _First name_ (First name should be italics)
-                        type: string
-                      lastName:
-                        description: |
-                          `Last name` (last name must be monospaced)
-                        type: string
-                  dependentIds:
-                    type: array
-                    description: IDs of Dependents .
-                    items:
-                      type: integer
-                  dependentNames:
-                    type: array
-                    description: Full Name of **Dependents** (Dependents must be bold).
-                    items:
-                      type: object
-                      properties:
-                        firstNameParts:
-                          description: Parts of **First Name** (First Name must be bold)
-                          type: object
-                          properties:
-                            firstName:
-                              description: This is a very very long description to test how will it show up on a API spec renderer tool such as RapiDoc. This lable must be big enough to wrap into next line 
-                              type: string
-                            aLongFieldForTestingHowItShowsUpInSchemaModelWhenItEncountersLongField:
-                              description: Dependent Last Name
-                              type: string
-                        dependentLastName:
-                          description: Dependent Last Name
-                          type: string
-                  hobbies:
-                    type: array
-                    description: array of objects
-                    items:
-                      type: object
-
-  /simple-object:
-    get:
-      tags:
-        - Test with various data types
-      summary: Simple object
-      description: Response schema is a simple object, which contains only primitive properties. For complex schema check out [nested object](#get-/nested-object)
-      responses:
-        '200':
-          description: successful operation
-          content:
-            application/json:
-              schema:
-                type: object
-                properties:
-                  name:
-                    description: Person Name
-                    type: string
-                  age:
-                    description: Person Age
-                    type: integer
-                    minimum: 1
-                    maximum: 100
-
-
-  /person:
-    post:
-      tags:
-        - Test with various data types
-      summary: Data Types with constraints
-      description: Request-Parameters and Response-Schema contains various data types and constrains. Check out how is it desplayed below
-      parameters:
-        - name: height
-          in: query
-          description: height (in inches)
-          required: true
-          example: 70
-          schema:
-            type: integer
-            format: int32
-            minimum: 12
-            maximum: 120
-        - name: full-name
-          in: query
-          description: Name of a person
-          required: true
-          schema:
-            type: string
-            minimum: 3
-        - name: social-connection
-          in: query
-          description: facebook, linkedin, github, instagram, twitter etc 
-          schema:
-            type: string
-            format: url
-        - name: email
-          in: query
-          required: true
-          schema:
-            type: string
-            format: email
-        - name: email-password
-          in: query
-          required: true
-          schema:
-            type: string
-            format: password
-        - name: date-of-birth
-          in: query
-          required: true
-          schema:
-            type: string
-            format: date
-        - name: phone
-          in: query
-          schema:
-            type: string
-            pattern: '/^\+(?:[0-9]-?){6,14}[0-9]$/'
-        - name: marital-status
-          in: query
-          required: true
-          example: married
-          schema:
-            type: string
-            enum:
-              - married
-              - unmarried
-              - widowed
-              - unknown
-            default: unknown
-        - name: interests
-          in: query
-          required: true
-          description: __Exploded Array__ will send separate querystring parameter for each items eg - `interests=computers&interests=movies`
-          schema:
-            type: array
-            example: 
-              - computers
-              - reading
-              - ['music', 'movies']
-            minItems: 1
-            maxItems: 3
-            items:
-              type: string
-              enum:
-                - computers
-                - hiking
-                - swiming
-                - movies
-                - music
-                - dancing
-                - reading
-                - painting
-              default: hiking   
-        - name: tags
-          in: query
-          description: __Not Exploded Array__ will send a single querystring parameter with comma separated string eg - `tags=tall,dark,handsome`
-          style: form
-          explode: false
-          schema:
-            type: array
-            items:
-              type: string
-      responses:
-        '200':
-          description: successful operation
-          content:
-            application/json:
-              schema:
-                type: array
-                items:
-                  $ref: '#/components/schemas/person'
+                $ref: "#/components/schemas/person"
 components:
+  securitySchemes:
+    JWT:
+      type: http
+      scheme: bearer
+      bearerFormat: JWT
+    ApiKey:
+      type: apiKey
+      in: header
+      name: API_TOKEN
   schemas:
-    category:
-      type: object
-      properties:
-        catId:
-          description: Category ID
-          allOf:
-            - $ref: '#/components/schemas/id'
-        name:
-          description: Category name
-          type: string
-          deprecated: true
-    id:
-      type: string
-      format: uuid
-      readOnly: true
     person:
       type: object
       required:
-        - name
-        - photoUrls
-      properties:
-        id:
-          description: Pet ID
-          allOf:
-            - $ref: '#/components/schemas/id'
-        category:
-          description: Categories this person belongs to
-          allOf:
-            - $ref: '#/components/schemas/category'
-        country:
-          type: object
-          deprecated: true
-          properties:
-            countryCode:
-              type: string
-            countryName:
-              type: string
-        dependentIds:
-          type: array
-          deprecated: true
-          description: IDs of Dependents .
-          items:
-            type: integer
-          example:
-            - 278
-            - 279
-            - 280
-            - 281
-        name:
-          description: Name of the person
-          type: string
-          minLength: 4
-          example: Guru
-        photoUrls:
-          description: The list of URL to a cute photos featuring pet
-          type: array
-          maxItems: 20
-          items:
+        - prop1
+      anyOf:
+      - properties:
+          prop1:
             type: string
-            format: url
-        tags:
-          description: Tags attached to the pet
-          type: array
-          minItems: 1
-          items:
-            $ref: '#/components/schemas/tag'
-        maritalStatus:
-          type: string
-          description: Marital status in case of adult
-          enum:
-            - married
-            - unmarried
-            - widowed
-        phone:
-          description: phone number in international format
-          type: string
-          pattern: '/^\+(?:[0-9]-?){6,14}[0-9]$/'
-          example: 123
-          nullable: true
-    tag:
-      type: object
-      properties:
-        id:
-          description: Tag ID
-          allOf:
-            - $ref: '#/components/schemas/id'
-        name:
-          description: Tag name
-          type: string
-          minLength: 1
+            description: Employee ID

package/docs/welcome.html

@@ -15,8 +15,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="API, RapiDoc, ReDoc, Swagger, SwaggerUI, Custom Element, async-api, Web Component, web-hooks, OpenAPI, REST, themes, dark mode, markdown, API documentation, open api console, API mock">
-
+  <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"/>
 
   <!-- Fonts -->
@@ -267,7 +267,7 @@
 <pre class="shadow code-block"><code class="html" style="border-radius:4px">&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/index.html

@@ -30,20 +30,25 @@
     ./specs/oneof1.yaml  <<< nested oneof
 -->
 <rapi-doc 
-  spec-url = "./specs/petstore.yaml" 
+  spec-url = "./specs/temp.yaml" 
   id="thedoc" 
   theme = "dark"
   render-style="read" 
   schema-style="tree"
+  use-path-in-nav-bar="true"
   show-components = "true"
   show-info = "true"
-  show-header = "false"
-  allow-search = "true"
-  allow-advanced-search = "false"
-  allow-server-selection = "false"
-  allow-authentication	= "false"
+  show-header = "true"
+  allow-search = "false"  
+  allow-advanced-search = "true"
+  allow-spec-url-load="false"
+  allow-spec-file-load="false"
+  allow-spec-file-download="true"
+  allow-server-selection = "true"
+  allow-authentication	= "true"
   update-route="false"
   match-type="regex"
+  persist-auth="true"
 ></rapi-doc>
 <!--
   <rapi-doc-mini

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rapidoc",
-  "version": "9.1.0",
+  "version": "9.1.4",
   "description": "RapiDoc - Open API spec viewer with built in console",
   "author": "Mrinmoy Majumdar <mrin9@yahoo.com>",
   "repository": {
@@ -29,12 +29,13 @@
   "module": "dist/rapidoc-min.js",
   "mode": "production",
   "dependencies": {
-    "@apitools/openapi-parser": "^0.0.9",
+    "@apitools/openapi-parser": "^0.0.10",
     "base64-arraybuffer": "^1.0.1",
+    "buffer": "^6.0.3",
     "lit-element": "2.5.1",
     "lit-html": "1.4.1",
-    "marked": "^3.0.4",
-    "prismjs": "^1.25.0"
+    "marked": "^4.0.10",
+    "prismjs": "^1.26.0"
   },
   "scripts": {
     "build": "NODE_ENV=production webpack --mode=production",
@@ -46,30 +47,30 @@
     "lint-fix": "./node_modules/eslint/bin/eslint.js --fix ./src/**"
   },
   "devDependencies": {
-    "@babel/core": "^7.15.5",
-    "@babel/eslint-parser": "^7.15.4",
-    "@babel/preset-env": "^7.15.6",
-    "babel-loader": "^8.2.2",
+    "@babel/core": "^7.16.7",
+    "@babel/eslint-parser": "^7.16.5",
+    "@babel/preset-env": "^7.16.8",
+    "babel-loader": "^8.2.3",
     "babel-plugin-template-html-minifier": "^4.1.0",
     "clean-webpack-plugin": "^4.0.0",
-    "compression-webpack-plugin": "^9.0.0",
-    "css-loader": "^6.2.0",
+    "compression-webpack-plugin": "^9.2.0",
+    "css-loader": "^6.5.1",
     "eslint": "^7.32.0",
-    "eslint-config-airbnb": "^18.2.1",
-    "eslint-import-resolver-webpack": "^0.13.1",
+    "eslint-config-airbnb": "^19.0.4",
+    "eslint-import-resolver-webpack": "^0.13.2",
     "eslint-loader": "^4.0.2",
-    "eslint-plugin-import": "^2.24.2",
-    "eslint-webpack-plugin": "3.0.1",
+    "eslint-plugin-import": "^2.25.4",
+    "eslint-webpack-plugin": "3.1.1",
     "file-loader": "^6.2.0",
     "filemanager-webpack-plugin": "^6.1.7",
-    "html-webpack-plugin": "^5.3.2",
+    "html-webpack-plugin": "^5.5.0",
     "inspectpack": "^4.7.1",
-    "style-loader": "^3.2.1",
-    "terser-webpack-plugin": "^5.2.4",
-    "webpack": "^5.53.0",
-    "webpack-bundle-analyzer": "^4.4.2",
-    "webpack-cli": "^4.8.0",
-    "webpack-dev-server": "^4.2.1"
+    "style-loader": "^3.3.1",
+    "terser-webpack-plugin": "^5.3.0",
+    "webpack": "^5.66.0",
+    "webpack-bundle-analyzer": "^4.5.0",
+    "webpack-cli": "^4.9.1",
+    "webpack-dev-server": "^4.7.3"
   },
   "engines": {
     "node": ">=10.21.0"