openapi-format - npm Package Compare versions

Comparing version 1.13.0 to 1.13.1

CHANGELOG.md

 ## unreleased
 
+## [1.13.1] - 2023-02-25
+
+- Prevent removal of empty objects in default examples (#72)
+- Update defaultSort.json, requestBody according to the spec (#69)
+- Bumped dependencies @stoplight/yaml, traverse
+- Build openapi-format as a Docker image
+
 ## [1.13.0] - 2022-11-12
@@ -4,0 +11,0 @@

defaultSort.json

@@ -9,3 +9,3 @@ {
   "parameters": ["name", "in", "description", "required", "schema"],
-  "requestBody": ["description", "headers", "content", "links"],
+  "requestBody": ["description", "required", "content"],
   "responses": ["description", "headers", "content", "links"],
@@ -12,0 +12,0 @@ "content": [],

openapi-format.js

@@ -441,4 +441,8 @@ #!/usr/bin/env node
     // Remove empty objects
-    if (node && Object.keys(node).length === 0 && node.constructor === Object && !['security', 'schemas'].includes(this.parent.key)) {
-      debugFilterStep = 'Filter - Remove empty objects'
+    if (node && Object.keys(node).length === 0 && node.constructor === Object
+      && !['security', 'schemas', 'default'].includes(this.parent.key)
+      && ((this.key === "examples" || this.key === "example")
+        || !this.path.includes('example') && !this.path.includes('examples'))
+    ) {
+      // debugFilterStep = 'Filter - Remove empty objects'
       this.delete();
@@ -445,0 +449,0 @@ }

package.json

 {
   "name": "openapi-format",
-  "version": "1.13.0",
+  "version": "1.13.1",
   "description": "Format an OpenAPI document by ordering, formatting and filtering fields.",
@@ -55,6 +55,6 @@ "keywords": [
   "dependencies": {
-    "@stoplight/yaml": "^4.2.2",
+    "@stoplight/yaml": "^4.2.3",
     "case-anything": "^2.1.10",
     "commander": "^7.1.0",
-    "traverse": "^0.6.6"
+    "traverse": "^0.6.7"
   },
@@ -61,0 +61,0 @@ "devDependencies": {

readme.md

@@ -935,3 +935,3 @@ ![openapi-format icon](./assets/openapi-format-logo.svg)
 ```shell
-$ openapi-format openapi.json -o openapi.json --convertTo "3.1"
+$ openapi-format openapi.json -o openapi-3.1.json --convertTo "3.1"
 ```
@@ -938,0 +938,0 @@

No alert changes

Improved metrics

Total package byte prevSize

117609

increased by0.35%

Lines of code

1547

increased by0.26%

Dependency changes

• Updated@stoplight/yaml@^4.2.3

• Updatedtraverse@^0.6.7