@readme/oas-examples - npm Package Compare versions

Comparing version 5.8.1 to 5.9.0

3.0/json/parameters-common.json

@@ -15,2 +15,4 @@ {
     "/anything/{id}": {
+      "summary": "[common] Summary",
+      "description": "[common] Description",
       "parameters": [
@@ -20,2 +22,3 @@ {
           "name": "id",
+          "description": "ID parameter",
           "schema": {
@@ -35,3 +38,4 @@ "type": "number"
       "get": {
-        "summary": "Get anything",
+        "summary": "[get] Summary",
+        "description": "[get] Description",
         "responses": {
@@ -44,3 +48,4 @@ "200": {
       "post": {
-        "summary": "Post anything",
+        "summary": "[post] Summary",
+        "description": "[post] Description",
         "parameters": [
@@ -58,3 +63,5 @@ {
     },
-    "/anything/{id}/{multiplePathParams}": {
+    "/anything/{id}/{action}": {
+      "summary": "[common] Summary",
+      "description": "[common] Description on an operation with **multiple** common path parameters.",
       "parameters": [
@@ -64,2 +71,3 @@ {
           "name": "id",
+          "description": "ID parameter",
           "schema": {
@@ -72,5 +80,10 @@ "type": "number"
           "in": "path",
-          "name": "multiplePathParams",
+          "name": "action",
+          "description": "Action parameter",
           "schema": {
-            "type": "string"
+            "type": "string",
+            "enum": [
+              "lists",
+              "statistics"
+            ]
           },
@@ -81,3 +94,4 @@ "required": true
       "get": {
-        "summary": "Get anything",
+        "summary": "[get] Summary",
+        "description": "[get] Description",
         "responses": {
@@ -90,3 +104,5 @@ "200": {
     },
-    "/anything/{id}/{duplicatePathParams}/{id}": {
+    "/anything/{id}/{action}/{id}": {
+      "summary": "[common] Summary",
+      "description": "[common] Description on an operation with **multiple** common path parameters, one of which is used more than once in the path.",
       "parameters": [
@@ -103,4 +119,32 @@ {
           "in": "path",
-          "name": "duplicatePathParams",
+          "name": "action",
+          "description": "Action parameter",
           "schema": {
+            "type": "string",
+            "enum": [
+              "lists",
+              "statistics"
+            ]
+          },
+          "required": true
+        }
+      ],
+      "get": {
+        "summary": "[get] Summary",
+        "description": "[get] Description",
+        "responses": {
+          "200": {
+            "description": "OK"
+          }
+        }
+      }
+    },
+    "/anything/{id}/override": {
+      "summary": "This path item has a common parameter that's overridden by the more specific operation.",
+      "parameters": [
+        {
+          "name": "id",
+          "in": "path",
+          "description": "ID parameter",
+          "schema": {
             "type": "string"
@@ -112,3 +156,13 @@ },
       "get": {
-        "summary": "Get anything",
+        "parameters": [
+          {
+            "name": "id",
+            "in": "path",
+            "description": "A comma-separated list of IDs",
+            "schema": {
+              "type": "string"
+            },
+            "required": true
+          }
+        ],
         "responses": {
@@ -115,0 +169,0 @@ "200": {

3.0/json/polymorphism.json

@@ -680,3 +680,2 @@ {
       "post": {
-        "description": "Use case for https://github.com/readmeio/api-explorer/issues/495",
         "requestBody": {
@@ -683,0 +682,0 @@ "$ref": "#/components/requestBodies/nested-one-of-ref"

package.json

@@ -12,3 +12,3 @@ {
   ],
-  "version": "5.8.1",
+  "version": "5.9.0",
   "repository": {
@@ -15,0 +15,0 @@ "type": "git",

No alert changes

Improved metrics

Total package byte prevSize

2068799

increased by0.13%

Lines of code

39007

increased by0.14%

No dependency changes