Request validation for Multi-segment path parameters in Swagger 2.0

This issue is related to the below proposal and PR which has already been merged. https://bitbucket.org/atlassian/swagger-request-validator/issues/121/multi-segment-path-parameters-in-swagger

https://bitbucket.org/atlassian/swagger-request-validator/pull-requests/78/implementation-for-matching-dynamic-paths/diff

When i was trying to use the version 1.4.7 for request validation then i found that we need to do some further enhancement to achieve our purpose.

When we call the method validateRequest(@Nonnull final Request request) of the class SwaggerRequestResponseValidator then it fails to do the request validation in case of Multi-segment path parameters.

Below is my proposal to fix this problem:

Implement another overload function of validateRequest(@Nonnull final Request request, boleean hasDynamicRequestURI) where hasDynamicRequestURI flag indicate that whether we are going to do the request validation for Multi-segment path parameters.

@Nonnull
    public ValidationReport validateRequest(@Nonnull final Request request) {
                validateRequest(request, false)
}

@Nonnull
    public ValidationReport validateRequest(@Nonnull final Request request, boolean hasDynamicRequestURI) {
        requireNonNull(request, "A request is required");

        return validateOnApiOperation(
            request.getPath(),
            request.getMethod(),
            apiOperation -> requestValidator.validateRequest(request, apiOperation),
            (apiOperation, report) -> withWhitelistApplied(report, apiOperation, request, null), hasDynamicRequestURI);
    }

Then change the below logic in validateOnApiOperation method of SwaggerRequestResponseValidator class

private ValidationReport validateOnApiOperation(@Nonnull final String path,
                                                    @Nonnull final Request.Method method,
                                                    @Nonnull final Function<ApiOperation, ValidationReport> validationFunction,
                                                    @Nonnull final BiFunction<ApiOperation, ValidationReport, ValidationReport> whitelistingFunction, boolean hasDynamicRequestURI) {

        final ValidationReport.MessageContext context = ValidationReport.MessageContext.create()
                .withRequestPath(path)
                .withRequestMethod(method)
                .build();

       ApiOperationMatch apiOperationMatch        

        If(hasDynamicRequestURI){
              apiOperationMatch = apiOperationResolver.findApiOperation(path, method, ApiPath::matchesDynamicPath);
           } else {
              apiOperationMatch = apiOperationResolver.findApiOperation(path, method);
           }

Please provide your feedback on this. If you would be okay with this proposed change then i would create PR for the same.

Comments (5)