Update docs

Author: blueswen

demo-mkdocs/docs/demo/openapi-spec/v3.1/non-oauth-scopes.yaml

@@ -0,0 +1,18 @@
+openapi: 3.1.0
+info:
+  title: Non-oAuth Scopes example
+  version: 1.0.0
+paths:
+  /users:
+    get:
+      security:
+        - bearerAuth:
+            - 'read:users'
+            - 'public'
+components:
+  securitySchemes:
+    bearerAuth:
+      type: http
+      scheme: bearer
+      bearerFormat: jwt
+      description: 'note: non-oauth scopes are not defined at the securityScheme level'

demo-mkdocs/docs/demo/openapi-spec/v3.1/webhook-example.yaml

@@ -0,0 +1,34 @@
+openapi: 3.1.0
+info:
+  title: Webhook Example
+  version: 1.0.0
+# Since OAS 3.1.0 the paths element isn't necessary. Now a valid OpenAPI Document can describe only paths, webhooks, or even only reusable components
+webhooks:
+  # Each webhook needs a name
+  newPet:
+    # This is a Path Item Object, the only difference is that the request is initiated by the API provider
+    post:
+      requestBody:
+        description: Information about a new pet in the system
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/Pet"
+      responses:
+        "200":
+          description: Return a 200 status to indicate that the data was received successfully
+
+components:
+  schemas:
+    Pet:
+      required:
+        - id
+        - name
+      properties:
+        id:
+          type: integer
+          format: int64
+        name:
+          type: string
+        tag:
+          type: string

demo-mkdocs/docs/demo/openapi-v3.1.md

@@ -0,0 +1,13 @@
+Support using local OpenAPI Specification file on website.
+
+## Markdown
+
+```html
+<swagger-ui src="./openapi-spec/sample.yaml"/>
+```
+
+## Swagger UI
+
+<swagger-ui src="./openapi-spec/v3.1/non-oauth-scopes.yaml"/>
+
+<swagger-ui src="./openapi-spec/v3.1/webhook-example.yaml"/>

demo-mkdocs/docs/index.md

@@ -21,7 +21,7 @@ A MkDocs plugin supports for add [Swagger UI](https://github.com/swagger-api/swa
 1. Python Package
     1. beautifulsoup4>=4.11.1
 2. [Swagger UI dist](https://www.npmjs.com/package/swagger-ui-dist) javascript file and css file
-    1. swagger-ui-dist==4.14.0
+    1. swagger-ui-dist==5.0.0-alpha.0
 
 ## Usage
 

demo-mkdocs/mkdocs.yml

@@ -68,3 +68,4 @@ nav:
     - Multiple: demo/multiple.md
     - Build-in Multiple: demo/build-in-multiple.md
     - OAuth2 Initialization: demo/oauth2.md
+    - OpenAPI v3.1: demo/openapi-v3.1.md