@Parameter info are ignored for header

[btocquec]

Hi,

Here is my controller part:

...
    @Operation(summary = "find-articles")
    @Parameter(name = HttpHeaders.IF_MODIFIED_SINCE,
            description = "DateTime",
            in = ParameterIn.HEADER,
            schema = @Schema(type = "string", format = "date-time"),
            example = "2020-01-01T00:00:00.000Z"
    )
    public ResponseEntity<Page<Article>> findArticles(
            @RequestHeader(value = HttpHeaders.IF_MODIFIED_SINCE, required = false) Instant modifiedSince, ...

I expect to see my example and my description in it but I've only got:

If I put this part under "parameters" in @operation it works but as I want to create my own reusable annotation, I'd like this @parameter to be used.

Looking deeper in the code, it appears that the binding can't be done between modifiedSince and HttpHeaders.IF_MODIFIED_SINCE where as the merge works if in @operation.

Regards,

[bnasslahsen]

@btocquec,

The merge doesn't happen, because your parameter name, doesn't have the same, as the one used in the swagger annotation @Parameter.
Here the working example:

	@Operation(summary = "find-articles")
	@GetMapping
	@Parameter(name = "modifiedSince",
			description = "DateTime",
			in = ParameterIn.HEADER,
			schema = @Schema(type = "string", format = "date-time"),
			example = "2020-01-01T00:00:00.000Z"
	)
	public ResponseEntity<String> findArticles(@RequestHeader(value = HttpHeaders.IF_MODIFIED_SINCE, required = false) Instant modifiedSince) {
		return null;
	}

[btocquec]

Yes but no :)
In that case, the parameter filled in the UI is not detected by my webService => the modifiedSince is null !

[bnasslahsen]

You have a first workaround, is to pass it with the parameter:

	public ResponseEntity<String> findArticles(@Parameter(name = HttpHeaders.IF_MODIFIED_SINCE,
			description = "DateTime",
			in = ParameterIn.HEADER,
			schema = @Schema(type = "string", format = "date-time"),
			example = "2020-01-01T00:00:00.000Z"
	) @RequestHeader(value = HttpHeaders.IF_MODIFIED_SINCE, required = false) Instant modifiedSince) {
		System.out.println(modifiedSince);
		return null;
	}

Passing it using @Parameter annotation on method level, should work as well. But doesn't seem to be for Header...

[btocquec]

Yes, I've already noticed this one and thanks for that but this my aim is to:

• have a reusable annotation that I can just declare on each needed method
• less "intrusive" code (prefer separating rest part and swagger context)

Exact, I have no issue for others parameters (path param for example) but for Header, the name of the java parameter and the name of the http parameter are different that's why I guess wwe can consider this as an issue?

Regards,

[bnasslahsen]

@btocquec,

Yeah, of course and the fix the should be available for the next release: v1.3.2

[btocquec]

Thanks, Great Job !!
I'll confirm/retest with next release.