v5.17.7 broke path template processing

[igor-tatarnikov-idt]

Q&A (please complete the following information)

• OS: MacOS, Windows
• Browser: Chrome, Safari
• Version: 126.0.6478.127
• Method of installation: Docker image or Swashbuckle ASP.NET package
• Swagger-UI version: 5.17.7
• Swagger/OpenAPI version: OpenAPI 3.0.1

Content & configuration

Example Swagger/OpenAPI definition:

{
  "openapi": "3.0.1",
  "info": {
    "title": "repro-swagger-issue",
    "version": "1.0"
  },
  "paths": {
    "/hello/name={name}": {
      "get": {
        "tags": [
          ""
        ],
        "parameters": [
          {
            "name": "name",
            "in": "path",
            "required": true,
            "style": "simple",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          }
        }
      }
    }
  },
  "components": { }
}

Swagger-UI configuration options:

Ran Swagger UI from Docker images v5.17.7 and v5.17.6 against locally running ASP.NET Core test web app

Describe the bug you're encountering

In v5.17.6 a path parameter gets populated with the value provided in the input. In v5.17.7+ it doesn't, the template {name} is sent in the request URL.

Expected behavior

Input path parameter value gets populated into the request URL

Screenshots

v5.17.7+

v5.17.6

Additional context or thoughts

I suppose the openapi-path-templating package is used for resolving path values (here in swagger-js). So, I thought maybe the template of type /api/hello/name={name} is no longer recognized as valid - tried to run the following locally:

const templatingEngine = require('openapi-path-templating');

const parseResult = templatingEngine.parse('/hello/name={name}');
console.log(parseResult.result.success);

console.log(templatingEngine.resolve('/hello/name={name}', { name: 'Bob'}));

Got:

true
/hello/name=Bob

So, I feel like the path template is fine. Looking at the v5.17.7 release I can't see anything related to the issue from above.

[maksim-sovkov]

Any updates?

[sratz]

We were also hit by the same issue and I did some analysis:

• In swagger-ui 5.17.7 swagger-js was updated from 3.27.3 to 3.27.7.
• There, https://github.com/swagger-api/swagger-js/pull/3504 moved from regex parsing to openapi-path-templating library.
• openapi-path-templating at that time had a broken BNF for the template: https://github.com/swaggerexpert/openapi-path-templating/blob/16f894f81b9e4679f313c55db2abd59854131796/src/path-templating.bnf path-literal does not allow = so the template is not resolved.
• Apparently this was fixed already in https://github.com/swaggerexpert/openapi-path-templating/pull/83/files which already got included in swagger-ui: https://github.com/swagger-api/swagger-js/pull/3549 https://github.com/swagger-api/swagger-ui/pull/10007

So it looks like this should be fixed in the upcoming swagger-ui version?

[praveeng-nair]

Any updates on this ?