Skip to content

Commit

Permalink
docs: fix delete response status code (#3785)
Browse files Browse the repository at this point in the history
  • Loading branch information
ndr-brt committed Jan 17, 2024
1 parent a195712 commit b113a82
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 5 deletions.
Expand Up @@ -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",
Expand Down
Expand Up @@ -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",
Expand Down
Expand Up @@ -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",
Expand Down

0 comments on commit b113a82

Please sign in to comment.