feat!: support deletion of Code Systems via DELETE /codesystems/:id

Author: cmark

commons/com.b2international.commons/src/com/b2international/commons/json/Json.java

@@ -72,6 +72,13 @@ public static <T> List<T> array(T...values) {
 		return ImmutableList.copyOf(values);
 	}
 
+	/**
+	 * Construct a new {@link Json} object which is basically a Map of String keys to any Object value. <code>null</code> values are ignored and the
+	 * associated keys will not be registered in the resulting {@link Json} object.
+	 * 
+	 * @param properties - key-value property pairs or <code>null</code>
+	 * @return a {@link Json} object instance, never <code>null</code>
+	 */
 	public static Json object(Object...properties) {
 		final ImmutableMap.Builder<String, Object> props = ImmutableMap.builder();
 		if (properties != null) {

core/com.b2international.snowowl.core.rest/src/com/b2international/snowowl/core/rest/codesystem/CodeSystemRestService.java

@@ -27,6 +27,7 @@
 import com.b2international.snowowl.core.codesystem.CodeSystemRequests;
 import com.b2international.snowowl.core.codesystem.CodeSystems;
 import com.b2international.snowowl.core.events.util.Promise;
+import com.b2international.snowowl.core.request.ResourceRequests;
 import com.b2international.snowowl.core.rest.AbstractRestService;
 import com.b2international.snowowl.core.rest.RestApiError;
 
@@ -180,4 +181,27 @@ public void update(
 				.getSync(COMMIT_TIMEOUT, TimeUnit.MINUTES);
 	}
 
+	@ApiOperation(
+			value="Delete a CodeSystem",
+			notes="Deletes a CodeSystem permanently from the server")
+	@ApiResponses({
+		@ApiResponse(code = 204, message = "No content", response = Void.class),
+		@ApiResponse(code = 400, message = "Bad Request", response = RestApiError.class),
+		@ApiResponse(code = 409, message = "CodeSystem cannot be deleted", response = RestApiError.class)
+	})
+	@DeleteMapping(value = "/{codeSystemId}")
+	@ResponseStatus(HttpStatus.NO_CONTENT)
+	public void delete(
+			@ApiParam(value="The code system identifier")
+			@PathVariable(value="codeSystemId") 
+			final String codeSystemId,
+			
+			@RequestHeader(value = X_AUTHOR, required = false)
+			final String author) {
+		ResourceRequests.prepareDelete(codeSystemId)
+			.build(author, "Delete ".concat(codeSystemId))
+			.execute(getBus())
+			.getSync(COMMIT_TIMEOUT, TimeUnit.MINUTES);
+	}
+	
 }

tests/com.b2international.snowowl.test.commons/src/com/b2international/snowowl/test/commons/codesystem/CodeSystemRestRequests.java

@@ -18,47 +18,62 @@
 import static com.b2international.snowowl.test.commons.rest.RestExtensions.givenAuthenticatedRequest;
 
 import java.util.Map;
+import java.util.concurrent.TimeUnit;
 
 import com.b2international.commons.json.Json;
 import com.b2international.snowowl.core.ResourceURI;
 import com.b2international.snowowl.core.api.IBranchPath;
+import com.b2international.snowowl.core.branch.Branch;
+import com.b2international.snowowl.core.repository.RepositoryRequests;
 import com.b2international.snowowl.snomed.common.SnomedTerminologyComponentConstants;
 import com.b2international.snowowl.test.commons.ApiTestConstants;
+import com.b2international.snowowl.test.commons.Services;
 
 import io.restassured.http.ContentType;
 import io.restassured.response.ValidatableResponse;
 
 /**
+ * Common requests for working with Code Systems (only SNOMED CT is supported).
+ * 
  * @since 4.7
  */
 public abstract class CodeSystemRestRequests {
 
-	public static ValidatableResponse createCodeSystem(IBranchPath branchPath, String shortName) {
-		return createCodeSystem(null, branchPath, shortName);
+	public static ValidatableResponse createCodeSystem(String codeSystemId) {
+		String branchPath = RepositoryRequests.branching().prepareCreate()
+			.setParent(Branch.MAIN_PATH)
+			.setName(codeSystemId)
+			.build(SnomedTerminologyComponentConstants.TOOLING_ID)
+			.execute(Services.bus())
+			.getSync(1, TimeUnit.MINUTES);
+		return createCodeSystem(null, branchPath, codeSystemId);
+	}
+	
+	public static ValidatableResponse createCodeSystem(IBranchPath branchPath, String codeSystemId) {
+		return createCodeSystem(branchPath.getPath(), codeSystemId);
+	}
+	
+	public static ValidatableResponse createCodeSystem(String branchPath, String codeSystemId) {
+		return createCodeSystem(null, branchPath, codeSystemId);
 	}
 
-	public static ValidatableResponse createCodeSystem(ResourceURI extensionOf, String shortName) {
-		return createCodeSystem(extensionOf, null, shortName);
+	public static ValidatableResponse createCodeSystem(ResourceURI extensionOf, String codeSystemId) {
+		return createCodeSystem(extensionOf, null, codeSystemId);
 	}
 
-	private static ValidatableResponse createCodeSystem(ResourceURI extensionOf, IBranchPath branchPath, String shortName) {
+	private static ValidatableResponse createCodeSystem(ResourceURI extensionOf, String branchPath, String codeSystemId) {
 		Json requestBody = Json.object(
-			"id", shortName,
-			"title", shortName,
-			"url", "organizationLink",
+			"id", codeSystemId,
+			"title", codeSystemId,
+			"url", SnomedTerminologyComponentConstants.SNOMED_URI_BASE,
 			"description", "citation",
 			"toolingId", SnomedTerminologyComponentConstants.TOOLING_ID,
-			"oid", "oid_" + shortName,
-			"language", "primaryLanguage"
+			"oid", "oid_" + codeSystemId,
+			"language", "primaryLanguage",
+			"extensionOf", extensionOf,
+			"branchPath", branchPath
 		);
 
-		
-		if (extensionOf != null) {
-			requestBody = requestBody.with("extensionOf", extensionOf);
-		} else if (branchPath != null) {
-			requestBody = requestBody.with("branchPath", branchPath.getPath());
-		}
-		
 		return givenAuthenticatedRequest(ApiTestConstants.CODESYSTEMS_API)
 				.contentType(ContentType.JSON)
 				.body(requestBody)
@@ -80,6 +95,13 @@ public static ValidatableResponse updateCodeSystem(String id, Map<?, ?> requestB
 				.then();
 	}
 
+	public static ValidatableResponse deleteCodeSystem(String codeSystemId) {
+		return givenAuthenticatedRequest(ApiTestConstants.CODESYSTEMS_API)
+				.delete("/{id}", codeSystemId)
+				.then();
+
+	}
+	
 	public static ValidatableResponse upgrade(ResourceURI upgradeOf, ResourceURI extensionOf) {
 		return givenAuthenticatedRequest("/upgrade")
 				.contentType(ContentType.JSON)