Merge pull request #8 from paulRbr/array-item-removal

remove: improve removal of array items

Author: lornajane

src/overlay.js

@@ -15,7 +15,11 @@ function applyOverlayToOpenAPI(spec, overlay) {
 				}
 				var parent = jsonpath.parent(spec, a.target)
 				const thingToRemove = path[0][path[0].length - 1]
-				delete parent[thingToRemove]
+				if (Array.isArray(parent)) {
+					parent.splice(thingToRemove, 1);
+				} else {
+					delete parent[thingToRemove];
+				}
 			}
 
 		} else {

test/expected/one-less-server.yaml

@@ -0,0 +1,8 @@
+openapi: 3.1.0
+info:
+  title: API servers
+  version: 1.0.0
+servers:
+  - url: 'https://api.example.com'
+    description: Production
+paths: {}

test/openapi/openapi-with-servers.yaml

@@ -0,0 +1,10 @@
+openapi: 3.1.0
+info:
+  title: API servers
+  version: 1.0.0
+servers:
+  - url: 'https://api.dev.example.com'
+    description: Dev
+  - url: 'https://api.example.com'
+    description: Production
+paths: {}

test/overlay.test.js

@@ -59,6 +59,17 @@ test('remove all description fields', () => {
 	expect(result).toEqual(expectedOutput);
 });
 
+test('remove a server array entry', () => {
+	const openapiFile = "test/openapi/openapi-with-servers.yaml";
+	const overlayFile = "test/overlays/remove-server.yaml";
+	const expectedFile = "test/expected/one-less-server.yaml";
+	const expectedOutput = fs.readFileSync(expectedFile, 'utf8');
+
+	const result = overlayFiles(openapiFile, overlayFile);
+
+	expect(result).toEqual(expectedOutput);
+});
+
 test('fail to update a primitive string type', () => {
 	const openapiFile = "test/openapi/immutable.yaml";
 	const overlayFile = "test/overlays/immutable.yaml";

test/overlays/remove-server.yaml

@@ -0,0 +1,9 @@
+overlay: 1.0.0
+info:
+  title: Remove dev server
+  version: 1.0.0
+extends: openapi-with-servers.yaml
+
+actions:
+  - target: $.servers[?( @.description == 'Dev' )]
+    remove: true