Empty error message in some code paths

[steve-chavez]

One last concern, we are still using NotFound error in a couple places, which returns an empty error json:

postgrest/src/PostgREST/ApiRequest/Types.hs

Line 82 in e2dd435

| NotFound

postgrest/src/PostgREST/Error.hs

Line 135 in e2dd435

toJSON NotFound = JSON.object []

This seems fine for now, but maybe should be improved later (add error msg, details etc) for better UX?

Originally posted by @taimoorzaeem in #3869 (comment)

[taimoorzaeem]

postgrest/src/PostgREST/ApiRequest.hs

Lines 166 to 175 in fc35d6d

	getResource :: AppConfig -> [Text] -> Either ApiRequestError Resource
	getResource AppConfig{configOpenApiMode, configDbRootSpec} = \case
	[] -> case configDbRootSpec of
	Just (QualifiedIdentifier _ pathName) -> Right $ ResourceRoutine pathName
	Nothing | configOpenApiMode == OADisabled -> Left NotFound
	| otherwise -> Right ResourceSchema
	[table] -> Right $ ResourceRelation table
	["rpc", pName] -> Right $ ResourceRoutine pName
	_ -> Left NotFound

We are return this NotFound empty error in two places:

• When db-root-spec is not set and openapi-mode is disabled
• When we have a path like localhost:3000/first/second/third

@steve-chavez I am thinking of introducing two new errors in for these two conditions. Maybe call them OpenApiDisabled and InvalidResourcePath?

[steve-chavez]

@steve-chavez I am thinking of introducing two new errors in for these two conditions. Maybe call them OpenApiDisabled and InvalidResourcePath?

What's the motivation for these? To have a message plus error code?

If so, it looks it would be an improvement. So yes, I agree.