/samplePath/_health and /samplePath/{id} are treated as the same one?

[Joshua-Tu]

HI, OAS tools community.

In my API JSON file, I have the following definition for these two endpoints. (/samplePath/_health & /samplePath/{id}

{
    "openapi": "3.0.0",
    "info": {
        "title": "Sample Service API",
        "description": "All about Sample Service",
        "version": "1.0"
    },
    "paths": {
        "/samplePath/_health": {
            "get": {
                "x-router-controller": "sampleController",
                "x-router-handle-subpaths": false,
                "operationId": "getSampleHealth",
                "tags": ["Api Health"],
                "description": "API to check health of the service",
                "responses": {
                    "200": {
                        "description": "Successful request.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/successResponse"
                                }
                            }
                        }
                    },
                    "default": {
                        "description": "Invalid request.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/samplePath/{id}": {
            "get": {
                "x-router-controller": "sampleController",
                "x-router-handle-subpaths": false,
                "operationId": "getSample",
                "description": "get sample by ID",
                "tags": ["Template"],
                "parameters": [
                    {
                        "name": "id",
                        "in": "path",
                        "required": true,
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Successful request.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/successResponse"
                                }
                            }
                        }
                    },
                    "default": {
                        "description": "Invalid request.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        }
    },
    ...
}

But when I call /samplePath/_health. I got this error: {"error":"TypeError: Cannot read property 'forEach' of undefined"}
Which is thrown from here: oas-validator.js

I added some console.logs in the oas-validator.js and oas-params.js

Then I got the following info.
Seems like oas tools treats the /samplePath/_health endpoint's _health as a path param.

🚀 ~ file: oas-params.js:13 ~ OASParams ~ methodParams undefined
🚀 ~ file: oas-params.js:14 ~ OASParams ~ pathParams undefined
🚀 ~ file: oas-params.js:13 ~ OASParams ~ methodParams [
{
name: 'id',
in: 'path',
required: true,
schema: { type: 'string' }
}
]
🚀 ~ file: oas-params.js:14 ~ OASParams ~ pathParams undefined
[12/12/2022 23:17:40.874 +00:00] [info] : Requested GET /templates/_health
🚀 ~ file: oas-validator.js:52 ~ OASRequestValidator ~ res.locals.oas.params { id: '_health' }
[12/12/2022 23:17:40.875 +00:00] [error] : TypeError: Cannot read property 'forEach' of undefined

How could I solve this issue?

Thanks.

[alesancor1]

This is a problem with the router, static routes should take preference over dynamic routes. Please open an issue following the template given when creating one.

For now, you could turn off RequestValidation and manage it in the controllers, like so:

// Controler.js
export function findSamplePath(req, res) {
    if (res.locals.oas.params?.id === "_health") {
       getSamplePathHealth(req, res) // Call to the controller that handles /samplePath/_health
   } else {
     /* Controller logic */
   }
}