[Question]: Duplicate schema names don't throw but are overwritten

[claudenirmachado]

Question

Is it possible for the library to throw an exception if there are duplicate schema names?
I have a large codebase that generates OpenAPI Server documentation based on annotations. However, the clients are affected by this issue, where some schemas are overwritten due to this duplication.

Affected Version

2.2.30

Context

It is related to this issue.

Checklist

• I have searched the existing issues and documentation before asking.
• I have provided enough information for others to understand my question.

[ClaudenirFreitas]

Hi all,
This repo helps to understand the issue.

• FooOneController class uses the FooResponse class from the dto package, having two properties (code and message)
• FooTwoController class uses the FooResponse class from the controller class, having only one property (message)

Checking the OpenAPI documentation, we have:

{
  "openapi": "3.1.0",
  "info": {
    "title": "OpenAPI definition",
    "version": "v0"
  },
  "servers": [
    {
      "url": "http://localhost:8080",
      "description": "Generated server url"
    }
  ],
  "paths": {
    "/foo/two": {
      "get": {
        "tags": [
          "foo-two-controller"
        ],
        "operationId": "fooResponseTwo",
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "*/*": {
                "schema": {
                  "$ref": "#/components/schemas/FooResponse"
                }
              }
            }
          }
        }
      }
    },
    "/foo/one": {
      "get": {
        "tags": [
          "foo-one-controller"
        ],
        "operationId": "fooResponseOne",
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "*/*": {
                "schema": {
                  "$ref": "#/components/schemas/FooResponse"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "FooResponse": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string"
          }
        }
      }
    }
  }
}

As you can see, the FooResponse schema uses the data structure provided by the FooTwoController class, which does not contain the code property (i.e., UUID).

I can see two potential solutions for this (open to correction):

1. Include a config to throw an exception when having duplicated schema names
2. Add a counter suffix to the schema names in case of duplication, e.g. FooResponse, FooResponse2.

[ClaudenirFreitas]

Tagging @daniel-kmiecik, who suggested opening this issue.