Add Header Object missing attributes

[micryc]

Refs #4196

[frantuma]

Seems great, only missing thing on top of unused import and new lines in testwould be - as you mentioned - support for schema.implementation / components.

As a test you could use something like:

    @Test
    public void testOperationWithResponseArraySchemaImplementation() {
        Reader reader = new Reader(new OpenAPI());
        OpenAPI openAPI = reader.read(GetOperationResponseHeaderWithArraySchemaImplementation.class);
        Yaml.prettyPrint(openAPI);
        // would expect
        String expectedYAML = "openapi: 3.0.1\n" +
                "paths:\n" +
                "  /path:\n" +
                "    get:\n" +
                "      summary: Simple get operation\n" +
                "      description: Defines a simple get operation with no inputs and a complex output\n" +
                "      operationId: getWithPayloadResponse\n" +
                "      responses:\n" +
                "        \"200\":\n" +
                "          description: voila!\n" +
                "          headers:\n" +
                "            Rate-Limit-Limit:\n" +
                "              description: The number of allowed requests in the current period\n" +
                "              style: simple\n" +
                "              schema:\n" +
                "                maxItems: 10\n" +
                "                minItems: 1\n" +
                "                type: array\n" +
                "                items:\n" +
                "                  $ref: '#/components/schemas/SampleResponseSchema'\n" +
                "      deprecated: true\n" +
                "components:\n" +
                "  schemas:\n" +
                "    SampleResponseSchema:\n" +
                "      type: object\n" +
                "      properties:\n" +
                "        id:\n" +
                "          type: string\n" +
                "          description: the user id";
        assertEquals(expectedYAML, Yaml.pretty(openAPI));
    }

    static class GetOperationResponseHeaderWithArraySchemaImplementation {
        @Operation(
                summary = "Simple get operation",
                description = "Defines a simple get operation with no inputs and a complex output",
                operationId = "getWithPayloadResponse",
                deprecated = true,
                responses = {
                        @ApiResponse(
                                responseCode = "200",
                                description = "voila!",
                                headers = {@Header(
                                        name = "Rate-Limit-Limit",
                                        description = "The number of allowed requests in the current period",
                                        array = @ArraySchema(maxItems = 10, minItems = 1,schema = @Schema(implementation = SampleResponseSchema.class)))})})
        @GET
        @Path("/path")
        public void simpleGet() {
        }
    }

this would mean passing components from OperationParser to the AnnotationUtils methods pipeline, as done in other cases. We must maintain backward compatibility, therefore new methods with new components param must be invoked from existing ones (passing null as param)

[frantuma]

not used import?

[frantuma]

I would add a new line (applies to all added methods)

[frantuma]

As mentioned we need to maintain APIs backward compatibility, keeping previous method signature calling new one:

public static Optional<Map<String, Header>> getHeaders(io.swagger.v3.oas.annotations.headers.Header[] annotationHeaders, JsonView jsonViewAnnotation) {
    return getHeaders(annotationHeaders, null, jsonViewAnnotation, false);
}

[frantuma]

APIs backward compatibility, keeping previous method signature calling new one:

public static Optional<Map<String, Header>> getHeaders(io.swagger.v3.oas.annotations.headers.Header[] annotationHeaders, JsonView jsonViewAnnotation, boolean openapi31) {
    return getHeaders(annotationHeaders, null, jsonViewAnnotation, openapi31);
}

[frantuma]

APIs backward compatibility, keeping previous method signature calling new one:

public static Optional<Header> getHeader(io.swagger.v3.oas.annotations.headers.Header header, JsonView jsonViewAnnotation) {
    return getHeader(header, null, jsonViewAnnotation);
}

[frantuma]

APIs backward compatibility, keeping previous method signature calling new one:

public static Optional<Header> getHeader(io.swagger.v3.oas.annotations.headers.Header header, JsonView jsonViewAnnotation, boolean openapi31) {
    return getHeader(header, null, jsonViewAnnotation, openapi31);
}

[frantuma]

add a space after comma

[frantuma]

add a space after comma

[micryc]

Fixes #2965 also.