From b113a82e3cd5c4a929e8ea2ece2590980dc6d27f Mon Sep 17 00:00:00 2001 From: ndr_brt Date: Wed, 17 Jan 2024 14:55:29 +0100 Subject: [PATCH] docs: fix delete response status code (#3785) --- .../edc/connector/api/management/asset/v3/AssetApi.java | 2 +- .../contractdefinition/ContractDefinitionApi.java | 2 +- .../api/management/policy/PolicyDefinitionApi.java | 6 +++--- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/extensions/control-plane/api/management-api/asset-api/src/main/java/org/eclipse/edc/connector/api/management/asset/v3/AssetApi.java b/extensions/control-plane/api/management-api/asset-api/src/main/java/org/eclipse/edc/connector/api/management/asset/v3/AssetApi.java index 73385b7d00a..25cce54316e 100644 --- a/extensions/control-plane/api/management-api/asset-api/src/main/java/org/eclipse/edc/connector/api/management/asset/v3/AssetApi.java +++ b/extensions/control-plane/api/management-api/asset-api/src/main/java/org/eclipse/edc/connector/api/management/asset/v3/AssetApi.java @@ -80,7 +80,7 @@ public interface AssetApi { "by a contract agreement, in which case an error is returned. " + "DANGER ZONE: Note that deleting assets can have unexpected results, especially for contract offers that have been sent out or ongoing or contract negotiations.", responses = { - @ApiResponse(responseCode = "200", description = "Asset was deleted successfully"), + @ApiResponse(responseCode = "204", description = "Asset was deleted successfully"), @ApiResponse(responseCode = "400", description = "Request was malformed, e.g. id was null", content = @Content(array = @ArraySchema(schema = @Schema(implementation = ApiCoreSchema.ApiErrorDetailSchema.class)))), @ApiResponse(responseCode = "404", description = "An asset with the given ID does not exist", diff --git a/extensions/control-plane/api/management-api/contract-definition-api/src/main/java/org/eclipse/edc/connector/api/management/contractdefinition/ContractDefinitionApi.java b/extensions/control-plane/api/management-api/contract-definition-api/src/main/java/org/eclipse/edc/connector/api/management/contractdefinition/ContractDefinitionApi.java index 74da979e1fb..38ec170b775 100644 --- a/extensions/control-plane/api/management-api/contract-definition-api/src/main/java/org/eclipse/edc/connector/api/management/contractdefinition/ContractDefinitionApi.java +++ b/extensions/control-plane/api/management-api/contract-definition-api/src/main/java/org/eclipse/edc/connector/api/management/contractdefinition/ContractDefinitionApi.java @@ -78,7 +78,7 @@ public interface ContractDefinitionApi { @Operation(description = "Removes a contract definition with the given ID if possible. " + "DANGER ZONE: Note that deleting contract definitions can have unexpected results, especially for contract offers that have been sent out or ongoing or contract negotiations.", responses = { - @ApiResponse(responseCode = "200", description = "Contract definition was deleted successfully"), + @ApiResponse(responseCode = "204", description = "Contract definition was deleted successfully"), @ApiResponse(responseCode = "400", description = "Request was malformed, e.g. id was null", content = @Content(array = @ArraySchema(schema = @Schema(implementation = ApiCoreSchema.ApiErrorDetailSchema.class)))), @ApiResponse(responseCode = "404", description = "A contract definition with the given ID does not exist", diff --git a/extensions/control-plane/api/management-api/policy-definition-api/src/main/java/org/eclipse/edc/connector/api/management/policy/PolicyDefinitionApi.java b/extensions/control-plane/api/management-api/policy-definition-api/src/main/java/org/eclipse/edc/connector/api/management/policy/PolicyDefinitionApi.java index 6992df970bd..59979bbd3fe 100644 --- a/extensions/control-plane/api/management-api/policy-definition-api/src/main/java/org/eclipse/edc/connector/api/management/policy/PolicyDefinitionApi.java +++ b/extensions/control-plane/api/management-api/policy-definition-api/src/main/java/org/eclipse/edc/connector/api/management/policy/PolicyDefinitionApi.java @@ -71,11 +71,11 @@ public interface PolicyDefinitionApi { ) JsonObject createPolicyDefinition(JsonObject policyDefinition); - @Operation(description = "Removes a policy definition with the given ID if possible. Deleting a policy definition is only possible if that policy definition is not yet referenced " + - "by a contract definition, in which case an error is returned. " + + @Operation(description = "Removes a policy definition with the given ID if possible. Deleting a policy definition is " + + "only possible if that policy definition is not yet referenced by a contract definition, in which case an error is returned. " + "DANGER ZONE: Note that deleting policy definitions can have unexpected results, do this at your own risk!", responses = { - @ApiResponse(responseCode = "200", description = "Policy definition was deleted successfully"), + @ApiResponse(responseCode = "204", description = "Policy definition was deleted successfully"), @ApiResponse(responseCode = "400", description = "Request was malformed, e.g. id was null", content = @Content(array = @ArraySchema(schema = @Schema(implementation = ApiCoreSchema.ApiErrorDetailSchema.class)))), @ApiResponse(responseCode = "404", description = "An policy definition with the given ID does not exist",