Support @Schema(hidden = true) on @Parameter

[membersound]

It would be nice to just set @Parameter(schema = @Schema(hidden = true)) to hide the Schema objects entirely.

Currently, the following still results in schema generation:

@PostMapping("/examplePost")
@Operation(summary = "schema example")
public Object example(@Parameter(schema = @Schema(hidden = true)) JsonNode json)) {
	
}

@GetMapping("/example")
public void test(@Parameter(schema = @Schema(hidden = true) JsonNode json) {

}

Results in:

"/example": {
  "post": {
	"requestBody":{
	   "content":{
	      "*/*":{
		 "schema":{
		    "$ref":"#/components/schemas/JsonNode"
		 }
	      }
	   },
	   "required":false
        }
  }
}
....

   "JsonNode":{
      "type":"object",
      "properties":{
         "float":{
            "type":"boolean"
         },
         "array":{
            "type":"boolean"
         },
         "null":{
            "type":"boolean"
         },
         "number":{
            "type":"boolean"
         },
         "floatingPointNumber":{
            "type":"boolean"
         },
         "containerNode":{
            "type":"boolean"
         },
         "missingNode":{
            "type":"boolean"
         },
         "object":{
            "type":"boolean"
         },
         "nodeType":{
            "type":"string",
            "enum":[
               "ARRAY",
               "BINARY",
               "BOOLEAN",
               "MISSING",
               "NULL",
               "NUMBER",
               "OBJECT",
               "POJO",
               "STRING"
            ]
         },
         "pojo":{
            "type":"boolean"
         },
         "integralNumber":{
            "type":"boolean"
         },
         "short":{
            "type":"boolean"
         },
         "int":{
            "type":"boolean"
         },
         "long":{
            "type":"boolean"
         },
         "double":{
            "type":"boolean"
         },
         "bigDecimal":{
            "type":"boolean"
         },
         "bigInteger":{
            "type":"boolean"
         },
         "textual":{
            "type":"boolean"
         },
         "boolean":{
            "type":"boolean"
         },
         "binary":{
            "type":"boolean"
         },
         "valueNode":{
            "type":"boolean"
         }
      }
   }

Hi,

To hide an object, you can just use hidden parameter on @parameter annotation.
@Parameter(hidden=true)

[membersound]

I don't want to hide the object! I only want to hide the schema displayed at the bottom of the swagger-ui.

Hi @membersound,

Could you please the sample expected OpenAPI (json/yml) description of the behaviour you are expecting?

[membersound]

Why is this issue closed?

Here is a sample:

@RestController
public class TestServlet {
	@GetMapping("/test")
	public void test(JsonNode json) {

	}
}

Produces:

{
   "openapi":"3.0.1",
   "paths":{
      "/test":{
         "get":{
            "operationId":"test",
            "parameters":[
               {
                  "name":"json",
                  "in":"query",
                  "required":true,
                  "schema":{
                     "$ref":"#/components/schemas/JsonNode"
                  }
               }
            ],

            "responses":{
               "200":{
                  "description":"default response"
               }
            }
         }
      },
      "/testPost":{
         "post":{
            "operationId":"testPost",
            "requestBody":{
               "content":{
                  "*/*":{
                     "schema":{
                        "$ref":"#/components/schemas/JsonNode"
                     }
                  }
               }
            },
            "responses":{
               "200":{
                  "description":"default response"
               }
            }
         }
      }
   },
   "components":{
      "schemas":{
         "JsonNode":{
            "type":"object",
            "properties":{
               "float":{
                  "type":"boolean"
               },
               "array":{
                  "type":"boolean"
               },
               "null":{
                  "type":"boolean"
               },
               "number":{
                  "type":"boolean"
               },
               "floatingPointNumber":{
                  "type":"boolean"
               },
               "containerNode":{
                  "type":"boolean"
               },
               "missingNode":{
                  "type":"boolean"
               },
               "object":{
                  "type":"boolean"
               },
               "nodeType":{
                  "type":"string",
                  "enum":[
                     "ARRAY",
                     "BINARY",
                     "BOOLEAN",
                     "MISSING",
                     "NULL",
                     "NUMBER",
                     "OBJECT",
                     "POJO",
                     "STRING"
                  ]
               },
               "pojo":{
                  "type":"boolean"
               },
               "integralNumber":{
                  "type":"boolean"
               },
               "short":{
                  "type":"boolean"
               },
               "int":{
                  "type":"boolean"
               },
               "long":{
                  "type":"boolean"
               },
               "double":{
                  "type":"boolean"
               },
               "bigDecimal":{
                  "type":"boolean"
               },
               "bigInteger":{
                  "type":"boolean"
               },
               "textual":{
                  "type":"boolean"
               },
               "boolean":{
                  "type":"boolean"
               },
               "binary":{
                  "type":"boolean"
               },
               "valueNode":{
                  "type":"boolean"
               }
            }
         }
      }
   }
}

This generates:

I want to hide the "JsonNode" output in "Schema" down below.

Hi @membersound,

Could you please the sample expected OpenAPI (json/yml) description of the behaviour you are expecting?

Your resuest do not seem relevant, as if we hide thé generated schema related, the OpenAPI description will be invalid.
But if you just clarify your expected result (using OpenApi yaml/json), we can have better understanding of your request.

[membersound]

If I want to hide the schema of a parameter, I would expect both the schema node in the requestBody and also in the components` section being empty:

{
   "openapi":"3.0.1",
   "paths":{
      "/test":{
         "get":{
            "operationId":"test",
            "parameters":[
               {
                  "name":"json",
                  "in":"query",
                  "required":true,
                  "schema":{
                     "$ref":"#/components/schemas/JsonNode"
                  }
               }
            ],

            "responses":{
               "200":{
                  "description":"default response"
               }
            }
         }
      },
      "/testPost":{
         "post":{
            "operationId":"testPost",
            "requestBody":{
               "content":{
                  "*/*":{
                     "schema":{ }
                  }
               }
            },
            "responses":{
               "200":{
                  "description":"default response"
               }
            }
         }
      }
   },
   "components":{
      "schemas": { }
   }
}

Hi,

Please copy and past your OpenAPI description on https://editor.swagger.io/, and you will see that the expected OpenAPI description is invalid:

Semanticerror at paths./test.get.parameters.0.schema.$ref $refs must reference a valid location in the document Jump to line 11

This part of the OpenAPI Descprition that you expect "$ref":"#/components/schemas/JsonNode", can never be genereted using @Schema(hidden = true) annotation.

If you want to change the generated schema, you can use $ref attribute instead. (This supposes you have declared the type JsonNode in a previous section of your code, to have a correct OpenApi Description)

    @RestController
    public class TestServlet {
        @GetMapping("/test")
        public void test(@Parameter(ref = "#/components/schemas/JsonNode") JsonNode json) {

        }
    }
` ` ` 

[membersound]

Sorry, I forgot to update the GET endpoint. Here is the example I'd expect by applying @Parameter(schema = @Schema(hidden = true) to the method parameters:

{
   "openapi":"3.0.1",
   "info": {
    "title": "example",
    "version": "1.0.0"
   },
   "paths":{
      "/test":{
         "get":{
            "operationId":"test",
            "parameters":[
               {
                  "name":"json",
                  "in":"query",
                  "required":true,
                  "schema":{ }
               }
            ],

            "responses":{
               "200":{
                  "description":"default response"
               }
            }
         }
      },
      "/testPost":{
         "post":{
            "operationId":"testPost",
            "requestBody":{
               "content":{
                  "*/*":{
                     "schema":{ }
                  }
               }
            },
            "responses":{
               "200":{
                  "description":"default response"
               }
            }
         }
      }
   },
   "components":{
      "schemas": { }
   }
}

Hi,

The fix will be available on v1.2.7, of springdoc-openapi.