@readme/oas-examples - npm Package Compare versions

Comparing version 5.11.1 to 5.12.0

3.0/json/schema-types.json

@@ -73,3 +73,3 @@ {
                     "type": "string",
-                    "description": "This parameter should be required."
+                    "description": "This string should be required."
                   },
@@ -86,2 +86,7 @@ "default": {
                   },
+                  "default (required)": {
+                    "type": "string",
+                    "description": "This string has a `default` of `default value` and is required.",
+                    "default": "default value"
+                  },
                   "nullable": {
@@ -102,2 +107,8 @@ "type": "string",
                   },
+                  "enum (with default and required)": {
+                    "type": "string",
+                    "description": "This enum has a `default` of `available` and is required.",
+                    "enum": ["available", "pending", "sold"],
+                    "default": "available"
+                  },
                   "enum (with empty option)": {
@@ -115,3 +126,3 @@ "type": "string",
                 },
-                "required": ["required"]
+                "required": ["required", "default (required)"]
               }
@@ -201,3 +212,4 @@ }
                   }
-                }
+                },
+                "required": ["binary (with default)"]
               }
@@ -282,3 +294,3 @@ }
                     "type": "integer",
-                    "description": "This parameter should be required."
+                    "description": "This integer should be required."
                   },
@@ -295,2 +307,7 @@ "integer (default)": {
                   },
+                  "integer (default, required)": {
+                    "type": "integer",
+                    "description": "This integer has a `default` of `1234` and is required.",
+                    "default": 1234
+                  },
                   "integer (nullable)": {
@@ -320,3 +337,3 @@ "type": "integer",
                     "type": "number",
-                    "description": "This parameter should be required."
+                    "description": "This number should be required."
                   },
@@ -333,2 +350,7 @@ "number (default)": {
                   },
+                  "number (default, required)": {
+                    "type": "number",
+                    "description": "This number has a `default` of `12.34` and is required.",
+                    "default": 12.34
+                  },
                   "number (nullable)": {
@@ -340,3 +362,3 @@ "type": "number",
                 },
-                "required": ["integer (required)", "number (required)"]
+                "required": ["integer (required)", "integer (default, required)", "number (required)", "number (default, required)"]
               }
@@ -467,3 +489,3 @@ }
                     "type": "boolean",
-                    "description": "This parameter should be required."
+                    "description": "This boolean should be required."
                   },
@@ -475,2 +497,7 @@ "default": {
                   },
+                  "default (required)": {
+                    "type": "boolean",
+                    "description": "This boolean has a `default` of `false`.",
+                    "default": false
+                  },
                   "inferred from enum": {
@@ -481,3 +508,3 @@ "description": "Though this is missing a `type` declaration it should be treated as `boolean` because it contains an enum of `true` and `false`.",
                 },
-                "required": ["required"]
+                "required": ["required", "default (required)"]
               }
@@ -484,0 +511,0 @@ }

3.1/json/schema-types.json

@@ -81,3 +81,3 @@ {
                     "type": "string",
-                    "description": "This parameter should be required."
+                    "description": "This string should be required."
                   },
@@ -94,2 +94,7 @@ "default": {
                   },
+                  "default (required)": {
+                    "type": "string",
+                    "description": "This string has a `default` of `default value` and is required.",
+                    "default": "default value"
+                  },
                   "nullable": {
@@ -110,2 +115,8 @@ "type": "string",
                   },
+                  "enum (with default and required)": {
+                    "type": "string",
+                    "description": "This enum has a `default` of `available` and is required.",
+                    "enum": ["available", "pending", "sold"],
+                    "default": "available"
+                  },
                   "enum (with empty option)": {
@@ -123,3 +134,3 @@ "type": "string",
                 },
-                "required": ["required"]
+                "required": ["required", "default (required)", "enum (with default and required)"]
               }
@@ -204,3 +215,4 @@ }
                   }
-                }
+                },
+                "required": ["binary (with default)"]
               }
@@ -270,3 +282,3 @@ }
                     "type": "integer",
-                    "description": "This parameter should be required."
+                    "description": "This integer should be required."
                   },
@@ -283,2 +295,7 @@ "integer (default)": {
                   },
+                  "integer (default, required)": {
+                    "type": "integer",
+                    "description": "This integer has a `default` of `1234` and is required.",
+                    "default": 1234
+                  },
                   "integer (nullable)": {
@@ -308,3 +325,3 @@ "type": "integer",
                     "type": "number",
-                    "description": "This parameter should be required."
+                    "description": "This number should be required."
                   },
@@ -316,2 +333,7 @@ "number (default)": {
                   },
+                  "number (default, required)": {
+                    "type": "number",
+                    "description": "This number has a `default` of `12.34` and is required.",
+                    "default": 12.34
+                  },
                   "number (default null)": {
@@ -328,3 +350,3 @@ "type": "number",
                 },
-                "required": ["integer (required)", "number (required)"]
+                "required": ["integer (required)", "integer (default, required)", "number (required)", "number (default, required)"]
               }
@@ -440,3 +462,3 @@ }
                     "type": "boolean",
-                    "description": "This parameter should be required."
+                    "description": "This boolean should be required."
                   },
@@ -448,2 +470,7 @@ "default": {
                   },
+                  "default (required)": {
+                    "type": "boolean",
+                    "description": "This boolean has a `default` of `false`.",
+                    "default": false
+                  },
                   "inferred from enum": {
@@ -454,3 +481,3 @@ "description": "Though this is missing a `type` declaration it should be treated as `boolean` because it contains an enum of `true` and `false`.",
                 },
-                "required": ["required"]
+                "required": ["required", "default (required)"]
               }
@@ -457,0 +484,0 @@ }

package.json

@@ -12,3 +12,3 @@ {
   ],
-  "version": "5.11.1",
+  "version": "5.12.0",
   "repository": {
@@ -28,7 +28,7 @@ "type": "git",
   "devDependencies": {
-    "@readme/eslint-config": "^10.5.2",
+    "@readme/eslint-config": "^10.6.2",
     "@readme/openapi-parser": "^2.5.0",
-    "eslint": "^8.37.0",
-    "fast-glob": "^3.2.11",
-    "jest": "^29.5.0",
+    "eslint": "^8.44.0",
+    "fast-glob": "^3.3.0",
+    "jest": "^29.6.1",
     "prettier": "^2.8.7"
@@ -35,0 +35,0 @@ },

No alert changes

Improved metrics

Total package byte prevSize

2086988

increased by0.27%

Lines of code

39218

increased by0.14%

No dependency changes