From 9cef3c276b4b8e2e9239c43fe8571c988508af4f Mon Sep 17 00:00:00 2001 From: Bartosz Gardziejewski Date: Thu, 2 Apr 2020 08:27:02 +0200 Subject: UpdateSwagger annotations and OpenAPI.yaml Issue-ID: AAF-1107 Signed-off-by: Bartosz Gardziejewski Change-Id: I8b5981385c70a2f6c2521be500e16faee211622b --- .../org/onap/aaf/certservice/api/CertificationController.java | 8 ++++---- .../java/org/onap/aaf/certservice/api/ReadinessController.java | 8 ++++---- .../org/onap/aaf/certservice/api/ReloadConfigController.java | 10 +++++----- 3 files changed, 13 insertions(+), 13 deletions(-) (limited to 'certService/src') diff --git a/certService/src/main/java/org/onap/aaf/certservice/api/CertificationController.java b/certService/src/main/java/org/onap/aaf/certservice/api/CertificationController.java index bf51e49e..c440ec34 100644 --- a/certService/src/main/java/org/onap/aaf/certservice/api/CertificationController.java +++ b/certService/src/main/java/org/onap/aaf/certservice/api/CertificationController.java @@ -64,14 +64,14 @@ public class CertificationController { * @param encodedPrivateKey Private key for CSR, needed for PoP, encoded in Base64 form * @return JSON containing trusted certificates and certificate chain */ - @GetMapping(value = "v1/certificate/{caName}", produces = "application/json; charset=utf-8") + @GetMapping(value = "v1/certificate/{caName}", produces = "application/json") @ApiResponses(value = { - @ApiResponse(responseCode = "200", description = "certificate successfully signed"), - @ApiResponse(responseCode = "400", description = "given CSR or/and PK is incorrect", + @ApiResponse(responseCode = "200", description = "Certificate successfully signed"), + @ApiResponse(responseCode = "400", description = "Given CSR or/and PK is incorrect", content = @Content(schema = @Schema(implementation = ErrorResponseModel.class))), @ApiResponse(responseCode = "404", description = "CA not found for given name", content = @Content(schema = @Schema(implementation = ErrorResponseModel.class))), - @ApiResponse(responseCode = "500", description = "something went wrong during connecting to cmp client", + @ApiResponse(responseCode = "500", description = "Something went wrong during connectiion to CMPv2 server", content = @Content(schema = @Schema(implementation = ErrorResponseModel.class))) }) @Operation( diff --git a/certService/src/main/java/org/onap/aaf/certservice/api/ReadinessController.java b/certService/src/main/java/org/onap/aaf/certservice/api/ReadinessController.java index f900edf9..9c8e1bf0 100644 --- a/certService/src/main/java/org/onap/aaf/certservice/api/ReadinessController.java +++ b/certService/src/main/java/org/onap/aaf/certservice/api/ReadinessController.java @@ -42,13 +42,13 @@ public final class ReadinessController { this.cmpServersConfig = cmpServersConfig; } - @GetMapping(value = "/ready", produces = "application/json; charset=utf-8") + @GetMapping(value = "/ready", produces = "application/json") @ApiResponses(value = { - @ApiResponse(responseCode = "200", description = "configuration is loaded and service is ready to use"), - @ApiResponse(responseCode = "503", description = "configuration loading failed and service is unavailable") + @ApiResponse(responseCode = "200", description = "Configuration is loaded and service is ready to use"), + @ApiResponse(responseCode = "503", description = "Configuration loading failed and service is unavailable") }) @Operation( - summary = "check is container is ready", + summary = "Check if CertService application is ready", description = "Web endpoint for checking if service is ready to be used.", tags = {"CertificationService"}) public ResponseEntity checkReady() { diff --git a/certService/src/main/java/org/onap/aaf/certservice/api/ReloadConfigController.java b/certService/src/main/java/org/onap/aaf/certservice/api/ReloadConfigController.java index e812ce0d..14bff8dd 100644 --- a/certService/src/main/java/org/onap/aaf/certservice/api/ReloadConfigController.java +++ b/certService/src/main/java/org/onap/aaf/certservice/api/ReloadConfigController.java @@ -46,15 +46,15 @@ public final class ReloadConfigController { this.cmpServersConfig = cmpServersConfig; } - @GetMapping(value = "/reload", produces = "application/json; charset=utf-8") + @GetMapping(value = "/reload", produces = "application/json") @ApiResponses(value = { - @ApiResponse(responseCode = "200", description = "configuration has been successfully reloaded"), - @ApiResponse(responseCode = "500", description = "something went wrong during configuration loading", + @ApiResponse(responseCode = "200", description = "Configuration has been successfully reloaded"), + @ApiResponse(responseCode = "500", description = "Something went wrong during configuration loading", content = @Content(schema = @Schema(implementation = ErrorResponseModel.class))) }) @Operation( - summary = "reload service configuration from file", - description = "Web endpoint for performing configuration reload. Used to reload configuration file from file.", + summary = "Reload CMPv2 servers configuration from configuration file", + description = "Web endpoint for performing configuration reload. Used to reload configuration from file.", tags = {"CertificationService"}) public ResponseEntity reloadConfiguration() throws CmpServersConfigLoadingException { cmpServersConfig.reloadConfiguration(); -- cgit 1.2.3-korg