Skip to content

Support required mode #2201

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

Merged
merged 2 commits into from
Apr 16, 2023
Merged
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 @@ -46,6 +46,7 @@
import io.swagger.v3.oas.annotations.enums.ParameterStyle;
import io.swagger.v3.oas.annotations.extensions.Extension;
import io.swagger.v3.oas.annotations.media.ExampleObject;
import io.swagger.v3.oas.annotations.media.Schema.RequiredMode;
import io.swagger.v3.oas.models.Components;
import io.swagger.v3.oas.models.examples.Example;
import io.swagger.v3.oas.models.media.ArraySchema;
Expand Down Expand Up @@ -326,7 +327,7 @@ private void setSchema(io.swagger.v3.oas.annotations.Parameter parameterDoc, Com
catch (Exception e) {
LOGGER.warn(Constants.GRACEFUL_EXCEPTION_OCCURRED, e);
}
if (schema == null) {
if (schema == null && parameterDoc.array() != null) {
schema = AnnotationsUtils.getSchema(parameterDoc.schema(), parameterDoc.array(), true, parameterDoc.array().schema().implementation(), components, jsonView).orElse(null);
// default value not set by swagger-core for array !
if (schema != null) {
Expand Down Expand Up @@ -358,7 +359,7 @@ Schema calculateSchema(Components components, ParameterInfo parameterInfo, Reque
WebConversionServiceProvider webConversionServiceProvider = optionalWebConversionServiceProvider.get();
if (!MethodParameterPojoExtractor.isSwaggerPrimitiveType((Class) type) && methodParameter.getParameterType().getAnnotation(io.swagger.v3.oas.annotations.media.Schema.class) == null) {
Class<?> springConvertedType = webConversionServiceProvider.getSpringConvertedType(methodParameter.getParameterType());
if (!(String.class.equals(springConvertedType) && ((Class<?>) type).isEnum()) && requestBodyInfo==null)
if (!(String.class.equals(springConvertedType) && ((Class<?>) type).isEnum()) && requestBodyInfo == null)
type = springConvertedType;
}
}
Expand Down Expand Up @@ -619,7 +620,9 @@ public String description() {

@Override
public boolean required() {
return schema.required();
return schema.requiredMode().equals(RequiredMode.AUTO) ?
schema.required() :
schema.requiredMode().equals(RequiredMode.REQUIRED);
}

@Override
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
package test.org.springdoc.api.v30.app206;

import java.util.Optional;

import javax.validation.constraints.Email;
import javax.validation.constraints.Max;
import javax.validation.constraints.Min;
import javax.validation.constraints.NotBlank;
import javax.validation.constraints.Pattern;
import javax.validation.constraints.Size;

import io.swagger.v3.oas.annotations.media.Schema;
import io.swagger.v3.oas.annotations.media.Schema.RequiredMode;

public class PersonRequest {
@Schema(requiredMode = RequiredMode.REQUIRED)
private long id;

@Schema(requiredMode = RequiredMode.NOT_REQUIRED)
private String firstName;

@NotBlank
@Size(max = 10)
private String lastName;

@Schema(requiredMode = RequiredMode.AUTO)
private Optional<String> email;

@Schema(required = true)
private int age;

public PersonRequest(long id, String firstName, String lastName, Optional<String> email, int age) {
this.id = id;
this.firstName = firstName;
this.lastName = lastName;
this.email = email;
this.age = age;
}

public long getId() {
return id;
}

public String getFirstName() {
return firstName;
}

public String getLastName() {
return lastName;
}

public Optional<String> getEmail() {
return email;
}

public int getAge() {
return age;
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
package test.org.springdoc.api.v30.app206;

import java.util.Optional;

import javax.validation.constraints.NotBlank;
import javax.validation.constraints.Size;

import io.swagger.v3.oas.annotations.media.Schema;
import io.swagger.v3.oas.annotations.media.Schema.RequiredMode;

public class PersonResponse {
@Schema
private long id;

@NotBlank
@Size(max = 10)
private String firstName;

@Schema(requiredMode = RequiredMode.REQUIRED)
private String lastName;

@Schema(requiredMode = RequiredMode.REQUIRED)
private Optional<String> email;

@Schema(required = true)
private int age;

public PersonResponse(long id, String firstName, String lastName, Optional<String> email, int age) {
this.id = id;
this.firstName = firstName;
this.lastName = lastName;
this.email = email;
this.age = age;
}

public long getId() {
return id;
}

public String getFirstName() {
return firstName;
}

public String getLastName() {
return lastName;
}

public Optional<String> getEmail() {
return email;
}

public int getAge() {
return age;
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
package test.org.springdoc.api.v30.app206;

import org.springdoc.api.annotations.ParameterObject;

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class RequiredModeController {
@GetMapping
public PersonResponse index(@ParameterObject PersonRequest request) {
return null;
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
package test.org.springdoc.api.v30.app206;

import test.org.springdoc.api.v30.AbstractSpringDocV30Test;

import org.springframework.boot.autoconfigure.SpringBootApplication;

public class SpringdocApp206Test extends AbstractSpringDocV30Test {

@SpringBootApplication
static class SpringDocTestApp {}

}
Original file line number Diff line number Diff line change
@@ -0,0 +1,113 @@
{
"openapi": "3.0.1",
"info": {
"title": "OpenAPI definition",
"version": "v0"
},
"servers": [
{
"url": "http://localhost",
"description": "Generated server url"
}
],
"paths": {
"/": {
"get": {
"tags": [
"required-mode-controller"
],
"operationId": "index",
"parameters": [
{
"name": "id",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "firstName",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "lastName",
"in": "query",
"required": true,
"schema": {
"maxLength": 10,
"minLength": 0,
"type": "string"
}
},
{
"name": "email",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "age",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/PersonResponse"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"PersonResponse": {
"required": [
"age",
"email",
"firstName",
"lastName"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64"
},
"firstName": {
"maxLength": 10,
"minLength": 0,
"type": "string"
},
"lastName": {
"type": "string"
},
"email": {
"type": "string"
},
"age": {
"type": "integer",
"format": "int32"
}
}
}
}
}
}