Handle removing an element, rather than just emptying, with tests

Author: lornajane

src/overlay.js

@@ -6,21 +6,36 @@ import mergician from 'mergician';
 function applyOverlayToOpenAPI(spec, overlay) {
 	// Use jsonpath.apply to do the changes
 	overlay.actions.forEach((a)=>{
-		jsonpath.apply(spec, a.target, (chunk) => {
-			// Is it a remove?
-			if (a.hasOwnProperty('remove')) {
-				return {};
+		// Is it a remove?
+		if (a.hasOwnProperty('remove')) {
+			// split the path expression
+			var target_pieces = jsonpath.parse(a.target);
+			// snag the last piece, we need this info to work out which element to remove
+			var final_segment = target_pieces.pop();
+			var target_key = "";
+			if(final_segment.expression.type == "identifier") {
+				target_key = final_segment.expression.value;
 			}
 
-			// It must be an update
+		    // Now rebuild the path up to before the final bit
+			var remaining_path = jsonpath.stringify(target_pieces);
 
-			// Deep merge using a module (built-in spread operator is only shallow)
-			const merger = mergician({appendArrays: true});
-			console.debug(a);
-			const merged = merger(chunk, a.update);
-			return merged;
-
-		});
+			// get the parent node and remove the target element
+			var node_value = jsonpath.value(spec, remaining_path);
+			delete node_value[target_key];
+			
+		} else {
+			// It must be an update
+			jsonpath.apply(spec, a.target, (chunk) => {
+				
+				// Deep merge using a module (built-in spread operator is only shallow)
+				const merger = mergician({appendArrays: true});
+				console.debug(a);
+				const merged = merger(chunk, a.update);
+				return merged;
+
+			});
+		}
 	})
 
 	return spec;

test/expected/output1.yaml

@@ -9,7 +9,6 @@ servers:
 paths:
   /pets:
     get:
-      summary: {}
       operationId: listPets
       tags:
         - pets

test/expected/town-remove-example.yaml

@@ -0,0 +1,22 @@
+openapi: 3.1.0
+info:
+  version: 1.0.0
+  title: Imaginary town
+servers:
+  - url: 'https://example.com'
+    description: Example server
+paths:
+  /buildings:
+    get:
+      summary: All buildings
+      operationId: buildingsAll
+      responses:
+        '200':
+          description: Return all known buildings
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  message:
+                    type: string

test/overlay.test.js

@@ -13,7 +13,7 @@ test('apply an overlay and check the output', () => {
 	expect(result).toEqual(expectedOutput);
 });
 
-test('apply an overlay and check the output', () => {
+test('add a description and update the summary', () => {
 	const openapiFile = "test/openapi/town.yaml";
 	const overlayFile = "test/overlays/building-description.yaml";
 	const expectedFile = "test/expected/town-building-description.yaml";
@@ -25,3 +25,15 @@ test('apply an overlay and check the output', () => {
 });
 
 
+test('remove an example', () => {
+	const openapiFile = "test/openapi/town.yaml";
+	const overlayFile = "test/overlays/remove-example.yaml";
+	const expectedFile = "test/expected/town-remove-example.yaml";
+	const expectedOutput = fs.readFileSync(expectedFile, 'utf8');
+
+	const result = overlayFiles(openapiFile, overlayFile);
+
+	expect(result).toEqual(expectedOutput);
+});
+
+

test/overlays/remove-example.yaml

@@ -0,0 +1,7 @@
+overlay: 1.0.0
+info:
+  title: Remove an example
+  version: 1.0.0
+actions:
+- target: $.paths['/buildings'].get.responses['200'].content['application/json'].schema.properties['message'].example
+  remove: true