Hide responses node

Usually the developer knows that an endpoint can at least produce HTTP 200 OK, 400 Bad Request and 5xx Server Error.

Therefore I’d like to hide the responses node (or at least any responses beside 200 OK).

But none of the following approaches work:

    @GetMapping(value = "/persons")
    @Operation(summary = "GET Persons",
            responses = {})
    public PersonRsp persons(final Person person) {
       return null;
    }

    @GetMapping(value = "/persons2")
    @Operation(summary = "GET Persons",
            responses = @ApiResponse(responseCode = "200"))
    public PersonRsp persons2(final Person person) {
       return null;
    }

Both endpoints will show:

"responses":{
   "502":{
      "description":"default response",
      "content":{
         "*/*":{
            "schema":{
               "type":"object"
            }
         }
      }
   },
   "400":{
      "description":"default response",
      "content":{
         "*/*":{
            "schema":{
               "type":"object"
            }
         }
      }
   },
   "200":{
      "description":"default response",
      "content":{
         "*/*":{
            "schema":{
               "$ref":"#/components/schemas/PersonRsp"
            }
         },
         "application/json":{
            "schema":{
               "$ref":"#/components/schemas/PersonRsp"
            }
         }
      }
   }
}

springdoc-1.1.33 and spring-boot-2.1.7

[springdoc]

As per OpenAPI 3 specification, your API description needs to specify the responses for all API operations. Each operation must have at least one response defined, usually a successful response. A response is defined by its HTTP status code and the data returned in the response body and/or headers:

• https://swagger.io/docs/specification/describing-responses/

If you need to hide HTTP Codes from other configurations (@ControllerAdvice), you can use @Hidden annotation on the methods of your ControllerAdvice.

[membersound]

Ok thanks for clarifying this. Let’s leave this issue closed, as my main question “how to hide responses” is solved then.

But I had to create a follow up issue regarding @Hidden on @ControllerAdvise: https://github.com/springdoc/springdoc-openapi/issues/81