Overriding Default Response Statuses in OpenAPI/Swagger for Specific Controller Methods

[sharpzilla]

How can I specify the source for generating the OpenAPI schema?

I have a controller where all methods are marked with two attributes: returning status 200 and status 403.

However, in one specific method (and only that one), I want it to return status 201 instead of 200 and status 409 instead of the 403 defined at the controller level.

Right now, the final schema for this method includes all four possible responses: 200, 201, 403, and 409.
Are there any built-in ways to implement this behavior?

I don’t want to manually annotate every method in the controller with attributes just because of one exceptional case.

[ApiController]
[Route("[controller]")]
[ProducesResponseType(StatusCodes.Status200OK)]
[ProducesResponseType(typeof(Type), StatusCodes.Status403Forbidden, MediaTypeNames.Application.Json)]
public class WeatherForecastController : ControllerBase
{
    [HttpGet(Name = "GetWeatherForecast")]
    [ProducesResponseType(typeof(IEnumerable<WeatherForecast>), StatusCodes.Status201Created)]
    [ProducesResponseType(typeof(Type), StatusCodes.Status409Conflict, MediaTypeNames.Application.Json)]
    public IEnumerable<WeatherForecast> Get()
    {
        return Enumerable.Range(1, 5).Select(index => new WeatherForecast
        {
            Date = DateOnly.FromDateTime(DateTime.Now.AddDays(index)),
            TemperatureC = Random.Shared.Next(-20, 55),
        })
        .ToArray();
    }
}

"responses": {
          "200": {
            "description": "OK",
            "content": {
              "text/plain": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/WeatherForecast"
                  }
                }
              },
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/WeatherForecast"
                  }
                }
              },
              "text/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/WeatherForecast"
                  }
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Type"
                }
              }
            }
          },
          "201": {
            "description": "Created",
            "content": {
              "text/plain": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/WeatherForecast"
                  }
                }
              },
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/WeatherForecast"
                  }
                }
              },
              "text/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/WeatherForecast"
                  }
                }
              }
            }
          },
          "409": {
            "description": "Conflict",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Type"
                }
              }
            }
          }
        }
      

[engineering87]

Hello @sharpzilla,
there is no built‑in options.
The simplest approach is to keep your controller defaults and write a small IOperationFilter to strip them for exceptional actions in the Swagger/OpenAPI output.