Skip to content

feat: type-use for method parameters #3011

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -617,9 +617,18 @@ public void applyBeanValidatorAnnotations(final MethodParameter methodParameter,
if (annotations != null) {
Schema<?> schema = parameter.getSchema();
SchemaUtils.applyValidationsToSchema(schema, annotations);
if (schema instanceof ArraySchema && isParameterObject && methodParameter instanceof DelegatingMethodParameter mp) {
Field field = mp.getField();
if (field != null && field.getAnnotatedType() instanceof AnnotatedParameterizedType paramType) {
if (schema instanceof ArraySchema && methodParameter instanceof DelegatingMethodParameter mp) {
java.lang.reflect.AnnotatedType annotatedType = null;
if (isParameterObject) {
Field field = mp.getField();
if (field != null) {
annotatedType = field.getAnnotatedType();
}
} else {
java.lang.reflect.Parameter param = mp.getParameter();
annotatedType = param.getAnnotatedType();
}
if (annotatedType instanceof AnnotatedParameterizedType paramType) {
java.lang.reflect.AnnotatedType[] typeArgs = paramType.getAnnotatedActualTypeArguments();
for (java.lang.reflect.AnnotatedType typeArg : typeArgs) {
List<Annotation> genericAnnotations = Arrays.stream(typeArg.getAnnotations()).toList();
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
/*
*
* * Copyright 2019-2020 the original author or authors.
* *
* * Licensed under the Apache License, Version 2.0 (the "License");
* * you may not use this file except in compliance with the License.
* * You may obtain a copy of the License at
* *
* * https://www.apache.org/licenses/LICENSE-2.0
* *
* * Unless required by applicable law or agreed to in writing, software
* * distributed under the License is distributed on an "AS IS" BASIS,
* * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* * See the License for the specific language governing permissions and
* * limitations under the License.
*
*/

package test.org.springdoc.api.v31.app19

import io.swagger.v3.oas.annotations.Parameter
import jakarta.validation.constraints.Max
import jakarta.validation.constraints.Min
import jakarta.validation.constraints.Size
import org.springframework.boot.autoconfigure.SpringBootApplication
import org.springframework.http.ResponseEntity
import org.springframework.web.bind.annotation.PostMapping
import org.springframework.web.bind.annotation.RequestMapping
import org.springframework.web.bind.annotation.RequestParam
import org.springframework.web.bind.annotation.RestController
import test.org.springdoc.api.v31.AbstractKotlinSpringDocMVCTest


class SpringDocApp19Test : AbstractKotlinSpringDocMVCTest() {
@SpringBootApplication
class DemoApplication
}

@RestController
@RequestMapping
class HelloController {

@PostMapping("euroMillions")
fun euroMillions(
@Parameter(description = "the numbers")
@RequestParam
@Size(min = 5, max = 5)
numbers: List<@Max(50) @Min(1) Int>,

@Parameter(description = "the stars")
@RequestParam
@Size(min = 2, max = 2)
stars: List<@Max(12) @Min(1) Int>
): ResponseEntity<String> {
return ResponseEntity.ok("ok")
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
{
"openapi": "3.1.0",
"info": {
"title": "OpenAPI definition",
"version": "v0"
},
"servers": [
{
"url": "http://localhost",
"description": "Generated server url"
}
],
"paths": {
"/euroMillions": {
"post": {
"tags": [
"hello-controller"
],
"operationId": "euroMillions",
"parameters": [
{
"name": "numbers",
"in": "query",
"description": "the numbers",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32",
"maximum": 50,
"minimum": 1
},
"maxItems": 5,
"minItems": 5
}
},
{
"name": "stars",
"in": "query",
"description": "the stars",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32",
"maximum": 12,
"minimum": 1
},
"maxItems": 2,
"minItems": 2
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"type": "string"
}
}
}
}
}
}
}
},
"components": {}
}