Path not found error handling

[zekth]

In the current state of the api the ValidateHttpRequest does the path lookup and the request validation at the same time. It ouputs an error slice of errors.ValidationError.
Issue is when you want to do composition in middleware you end up with logic like:

skipServe := false
valid, validationErrs := docValidator.ValidateHttpRequest(r)
if !valid {
	for _, e := range validationErrs {
		if opts.RouteNotFoundHook != nil && e.ValidationType == "path" && e.ValidationSubType == "missing" {
			skipServe = opts.RouteNotFoundHook(e, w, r)
			break
		}

		if opts.RouteValidationErrorHook != nil {
			skipServe = opts.RouteValidationErrorHook(e, w, r)
			break
		}
	}
}

Solutions:

• Expose a specific error for a path not found
• Expose a function to check if the error is a path not found

wdyt?

[daveshanley]

Hi,

Have you seen this?

https://github.com/pb33f/libopenapi-validator/blob/main/requests/request_body.go#L26

and

https://github.com/pb33f/libopenapi-validator/blob/main/paths/paths.go#L22

The top level validator does not give you control over things like this, however the individual validators do.

[daveshanley]

I think some better docs will help here.

[zekth]

I did find those; I'd rather stick to the use of path. I was throwing this as in the code it already does this path check in the validateRequest function:

libopenapi-validator/validator.go

Lines 122 to 133 in e86a2da

	if v.foundPath == nil {
	pathItem, errs, pathValue = paths.FindPath(request, v.v3Model)
	if pathItem == nil || errs != nil {
	v.errors = errs
	return false, errs
	}
	v.foundPath = pathItem
	v.foundPathValue = pathValue
	} else {
	pathItem = v.foundPath
	pathValue = v.foundPathValue
	}

If i want to do composition like describe i'd have preferred to not repeat the operation twice. However i think it's better this way than to rebuild an adhoc composed validation function.

[daveshanley]

Would IsPathMissingError() bool as a method on errors.ValidationError work?

[zekth]

Looks good to me