Redundant deprecation

[apervushin]

Hi,

Issue similar to #1957

We have two response models Response1 and Response2, both include model Item. In Response2 item marked as deprecated. In swagger json Item marked as deprecated in both Response1 and Response2 instead of only Response2.

If we remove @Deprecated from Response2 and add into Response1 there is no deprecated flag in both Response1 and Response2.

Example:

@RestController("/")
public class HelloController {

    public record Item(int val) {}

    public record Response1(Item item) {} // here item also marked as deprecated

    public record Response2(@Deprecated @Schema(deprecated = true) Item item) {}

    @GetMapping("1")
    public Response1 test1() {
        return new Response1(new Item(1));
    }

    @GetMapping("2")
    public Response2 test2() {
        return new Response2(new Item(1));
    }
}

Json:

{
    "components":
    {
        "schemas":
        {
            "Item":
            {
                "type": "object",
                "properties":
                {
                    "val":
                    {
                        "type": "integer",
                        "format": "int32"
                    }
                },
                "deprecated": true
            },
            "Response2":
            {
                "type": "object",
                "properties":
                {
                    "item":
                    {
                        "$ref": "#/components/schemas/Item"
                    }
                }
            },
            "Response1":
            {
                "type": "object",
                "properties":
                {
                    "item":
                    {
                        "$ref": "#/components/schemas/Item"
                    }
                }
            }
        }
    }
}

[bnasslahsen]

@apervushin,

This is not a bug.

If you want different Item Schemas for your responses: See FAQ: How can i define different schemas for the same class?

If you want same schema for both Item responses, then you should move the deprecation annotations to that class.

[asaunin]

@bnasslahsen this approach seems extremely strange for me. What is the motivation to deprecate the whole Schema in case, when just a single field is marked as deprecated?

In my particular case, I have just renamed field and for backward compatibility reasons I have marked an old filed name as deprecated. But in fact, both fields (old one, new one) and the whole schema were deprecated!

From my prospective, such kind of concept provides more misunderstanding and causes issues, than helps somehow.

[bnasslahsen]

@asaunin,

Feel free to propose a PR, if you feel you have better enhancement and we will consider it.