rapidoc 9.1.3 → 9.1.4

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/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/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/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
                       }
-                    }
                   }
-                }
-              }
-            }
+              ]
           }
-        }
       }
-    }
   }
 }

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,22 +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 = "true"
+  allow-search = "false"  
+  allow-advanced-search = "true"
   allow-spec-url-load="false"
   allow-spec-file-load="false"
-  allow-search = "true"
-  allow-advanced-search = "false"
-  allow-server-selection = "false"
-  allow-authentication	= "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