Merge pull request #47 from daglem/status-response-cleanup

Clean up status responses

Author: stevehu

src/main/java/com/mservicetech/openapi/validation/OpenApiValidator.java

@@ -54,7 +54,7 @@ public class OpenApiValidator {
     final String VALIDATOR_REQUEST_PARAMETER_QUERY_MISSING = "ERR11000";
 
     final String VALIDATOR_RESPONSE_CONTENT_UNEXPECTED = "ERR11018";
-    final String REQUIRED_RESPONSE_HEADER_MISSING = "ERR11019";
+    final String VALIDATOR_RESPONSE_HEADER_MISSING = "ERR11020";
 
     final String DEFAULT_STATUS_CODE = "default";
 
@@ -139,7 +139,7 @@ public Status validateRequestPath (String requestURI , String httpMethod, Reques
             }
         } catch (NullPointerException e) {
             // This exception is thrown from within the OpenApiOperation constructor on operation == null.
-            return new Status(STATUS_METHOD_NOT_ALLOWED, requestURI);
+            return new Status(STATUS_METHOD_NOT_ALLOWED, httpMethod, requestURI);
         }
 
         if (requestEntity!=null) {
@@ -446,7 +446,7 @@ public Status validateResponsePath(String requestURI, String httpMethod, String
             }
         } catch (NullPointerException e) {
             // This exception is thrown from within the OpenApiOperation constructor on operation == null.
-            return new Status(STATUS_METHOD_NOT_ALLOWED, requestURI);
+            return new Status(STATUS_METHOD_NOT_ALLOWED, httpMethod, requestURI);
         }
         Status status = validateHeaders(responseEntity.getHeaders(), openApiOperation, statusCode);
         if(status != null) return status;
@@ -462,7 +462,7 @@ private Status validateHeaders(Map<String, ?> headers, OpenApiOperation operatio
                     //based on OpenAPI specification, ignore "Content-Type" header
                     //If a response header is defined with the name "Content-Type", it SHALL be ignored. - https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#responseObject
                     .filter(entry -> !"Content-Type".equalsIgnoreCase(entry.getKey()))
-                    .map(p -> validateHeader(headers, p.getKey(), p.getValue()))
+                    .map(p -> validateHeader(headers, p.getKey(), p.getValue(), operation))
                     .filter(s -> s != null)
                     .findFirst();
             if(optional.isPresent()) {
@@ -472,7 +472,7 @@ private Status validateHeaders(Map<String, ?> headers, OpenApiOperation operatio
         return null;
     }
 
-    private Status validateHeader(Map<String, ?> headers, String headerName, Header operationHeader) {
+    private Status validateHeader(Map<String, ?> headers, String headerName, Header operationHeader, OpenApiOperation openApiOperation) {
         // According to RFC7230, header field names are case-insensitive.
         Optional<Object> headerValue = Optional.ofNullable(headers).flatMap(opt -> opt.entrySet()
                 .stream()
@@ -482,7 +482,7 @@ private Status validateHeader(Map<String, ?> headers, String headerName, Header
         );
         if (headerValue.isEmpty()) {
             if (Boolean.TRUE.equals(operationHeader.getRequired())) {
-                return new Status(REQUIRED_RESPONSE_HEADER_MISSING, headerName);
+                return new Status(VALIDATOR_RESPONSE_HEADER_MISSING, headerName, openApiOperation.getPathString().original());
             }
         } else {
             SchemaValidatorsConfig config = new SchemaValidatorsConfig();

src/main/resources/status.yml

@@ -166,7 +166,7 @@ ERR10008:
   statusCode: 405
   code: ERR10008
   message: METHOD_NOT_ALLOWED
-  description: Request method cannot be found in the spec.
+  description: Request method %s cannot be found in the path %s.
 ERR10009:
   statusCode: 408
   code: ERR10009
@@ -366,7 +366,7 @@ ERR10048:
   statusCode: 404
   code: ERR10048
   message: PATH_NOT_IMPLEMENTED
-  description: No handler defined for path '%s'
+  description: No handler defined for path '%s' and method %s
 ERR10049:
   statusCode: 403
   code: ERR10049
@@ -433,7 +433,7 @@ ERR11000:
   statusCode: 400
   code: ERR11000
   message: VALIDATOR_REQUEST_PARAMETER_QUERY_MISSING
-  description: Query parameter %s is required, but not found in request.
+  description: Query parameter %s is required on path %s but not found in request.
 ERR11001:
   statusCode: 400
   code: ERR11001
@@ -505,25 +505,35 @@ ERR11014:
   message: VALIDATOR_REQUEST_BODY_MISSING
   description: Method %s on path %s requires a request body. None found.
 ERR11015:
-  statusCode: 400
+  statusCode: 500
   code: ERR11015
   message: VALIDATOR_RESPONSE_STATUS_UNKNOWN
   description: Response status %d not defined for path %s.
 ERR11016:
-  statusCode: 400
+  statusCode: 500
   code: ERR11016
   message: VALIDATOR_RESPONSE_BODY_MISSING
   description: Method %s on path %s defines a response schema but no response body found.
 ERR11017:
   statusCode: 400
   code: ERR11017
   message: VALIDATOR_REQUEST_PARAMETER_HEADER_MISSING
-  description: Header parameter %s is required, but not found in request.
+  description: Header parameter %s is required on path %s but not found in request.
 ERR11018:
-  statusCode: 400
+  statusCode: 500
   code: ERR11018
   message: VALIDATOR_RESPONSE_CONTENT_UNEXPECTED
   description: No response body content or schema is expected for %s on path %s.
+ERR11019:
+  statusCode: 400
+  code: ERR11019
+  message: STARTUP_HOOK_NOT_LOADED
+  description: Startup hook %s is not loaded properly.
+ERR11020:
+  statusCode: 500
+  code: ERR11020
+  message: VALIDATOR_RESPONSE_HEADER_MISSING
+  description: Response header %s is required on path %s but is not found.
 
 # 11100-11199 Light Code Generator validation errors
 ERR11100: