swagger-parser icon indicating copy to clipboard operation
swagger-parser copied to clipboard

OpenAPIParser is resolving the wrong schema for an operation

Open simondean opened this issue 2 years ago • 1 comments

See the following repo for a minimal reproduction of this issue:

  • https://github.com/simondean/swagger-request-validator-filename-issue
  • https://github.com/simondean/swagger-request-validator-filename-issue/blob/main/src/test/java/IssueDemoTest.java
  • https://github.com/simondean/swagger-request-validator-filename-issue/blob/main/example-openapi.yaml

Here's an example OpenAPI spec that demonstrates the issue:

https://github.com/simondean/swagger-request-validator-filename-issue/blob/main/example-openapi.yaml

openapi: 3.0.1
info:
  title: Example OpenAPI spec
  version: 0.0.1
paths:
  '/example':
    post:
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExamplePost'
      responses:
        204:
          description: No content
components:
  schemas:
    # Renaming this key from `Example` to `ExampleGet` stops the issue from occurring
    # Removing this key stops the issue from occurring
    Example:
      $ref: example.get.yaml
    ExamplePost:
      $ref: example.post.yaml

The comments in the code snippet show how the issue only happens when the unused schema is called Example. Rename it to ExampleGet or delete it, and the issue stops. The word Example is unimportant, other than it seems to need to be similar to the other schema that is used. Both schemes could be renamed to Anything and AnythingPost and you would still get the issue

Expected Behaviour

The following assertion should pass:

        assertEquals("POST Example", api.getPaths()
                .get("/example")
                .getPost()
                .getRequestBody()
                .getContent()
                .get("application/json")
                .getSchema()
                .getTitle());

Actual Behaviour

Swagger Parser loads the wrong request body schema for the POST operation. It's request body description is set to GET Example when it should be POST Example:

expected: <POST Example> but was: <GET Example>

simondean avatar Oct 26 '21 16:10 simondean

Hi @simondean

This issue happens when the referenced file name contains more than 1 dot. I have raised a PR to fix this issue - https://github.com/swagger-api/swagger-parser/pull/1622

As a workaround, you can rename the referenced files as example-get.yaml and example-post.yaml (without 2 dots), till the fix will be merged.

Thanks, Mohammed

ymohdriz avatar Oct 28 '21 13:10 ymohdriz