Merge pull request #13 from lornajane/fix-remove-stops-after-one

Make sure to catch all targeted items in the remove

Author: magicmonkey

src/overlay.js

@@ -9,7 +9,7 @@ function applyOverlayToOpenAPI(spec, overlay) {
 		// Is it a remove?
 		if (a.hasOwnProperty('remove')) {
 			while(true) {
-				var path = jsonpath.paths(spec, a.target, 1)
+				var path = jsonpath.paths(spec, a.target)
 				if (path.length == 0) {
 					break
 				}

test/expected/remove-responses.yaml

@@ -0,0 +1,20 @@
+openapi: 3.1.0
+info:
+  title: Responses
+  version: 1.0.0
+paths:
+  /foo:
+    get:
+      responses:
+        '200':
+          description: OK
+  /bar:
+    post:
+      responses:
+        '201':
+          description: Created
+  /baa:
+    post:
+      responses:
+        '201':
+          description: Shouted

test/openapi/responses.yaml

@@ -0,0 +1,30 @@
+openapi: 3.1.0
+info:
+  title: Responses
+  version: 1.0.0
+paths:
+  /foo:
+    get:
+      responses:
+        '200':
+          description: OK
+        '500':
+          description: oops
+  /bar:
+    post:
+      responses:
+        '201':
+          description: Created
+        '500':
+          description: oops
+        default:
+          description: something
+  /baa:
+    post:
+      responses:
+        '201':
+          description: Shouted
+        '500':
+          description: oops
+        default:
+          description: something

test/overlay.test.js

@@ -114,3 +114,14 @@ test('overlay document with empty actions is a nop', () => {
 	expect(result).toEqual(expectedOutput);
 });
 
+test('remove all matching responses', () => {
+	const openapiFile = "test/openapi/responses.yaml";
+	const overlayFile = "test/overlays/remove-responses.yaml";
+	const expectedFile = "test/expected/remove-responses.yaml";
+	const expectedOutput = fs.readFileSync(expectedFile, 'utf8');
+
+	const result = overlayFiles(openapiFile, overlayFile);
+
+	expect(result).toEqual(expectedOutput);
+});
+

test/overlays/remove-responses.yaml

@@ -0,0 +1,13 @@
+overlay: 1.0.0
+info:
+  title: Response code removal test
+  version: 1.0.0
+
+extends: response-codes.yaml
+
+actions:
+  - target: $.paths..responses['500']
+    remove: true
+
+  - target: $.paths..responses['default']
+    remove: true