Fixed the webhook example (OAI#2434)

Signed-off-by: Christian Franchin dos Santos <christian@corp.kionux.com.br>
charjr · Apr 27, 2023 · 7b2b81e · 7b2b81e
1 parent 5409156
commit 7b2b81e
Show file tree

Hide file tree

Showing 2 changed files with 1 addition and 65 deletions.
diff --git a/examples/v3.1/webhook-example.json b/examples/v3.1/webhook-example.json
@@ -4,38 +4,6 @@
     "title": "Webhook Example",
     "version": "1.0.0"
   },
-  "paths": {
-    "/pets": {
-      "get": {
-        "summary": "List all pets",
-        "operationId": "listPets",
-        "parameters": [
-          {
-            "name": "limit",
-            "in": "query",
-            "description": "How many items to return at one time (max 100)",
-            "required": false,
-            "schema": {
-              "type": "integer",
-              "format": "int32"
-            }
-          }
-        ],
-        "responses": {
-          "200": {
-            "description": "A paged array of pets",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/Pets"
-                }
-              }
-            }
-          }
-        }
-      }
-    }
-  },
   "webhooks": {
     "newPet": {
       "post": {
@@ -76,12 +44,6 @@
             "type": "string"
           }
         }
-      },
-      "Pets": {
-        "type": "array",
-        "items": {
-          "$ref": "#/components/schemas/Pet"
-        }
       }
     }
   }

diff --git a/examples/v3.1/webhook-example.yaml b/examples/v3.1/webhook-example.yaml
@@ -2,28 +2,7 @@ openapi: 3.1.0
 info:
   title: Webhook Example
   version: 1.0.0
-paths:
-  # OpenAPI documents all need a paths element
-  /pets:
-    get:
-      summary: List all pets
-      operationId: listPets
-      parameters:
-        - name: limit
-          in: query
-          description: How many items to return at one time (max 100)
-          required: false
-          schema:
-            type: integer
-            format: int32
-      responses:
-        '200':
-          description: A paged array of pets
-          content:
-            application/json:    
-              schema:
-                $ref: "#/components/schemas/Pets"
-
+# 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:
@@ -53,9 +32,4 @@ components:
           type: string
         tag:
           type: string
-    Pets:
-      type: array
-      items:
-        $ref: "#/components/schemas/Pet"
-