Skip to content

chore: remove intermediate fix methods for OAS31 exclusive constraints and null-only additional properties #3305

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.

Sign up for GitHub

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

Draft
Mattias-Sehlstedt wants to merge 1 commit into
base: main
Choose a base branch
from
+0 −63
Draft

chore: remove intermediate fix methods for OAS31 exclusive constraints and null-only additional properties #3305

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
28 changes: 0 additions & 28 deletions springdoc-openapi-starter-common/src/main/java/org/springdoc/core/utils/SchemaUtils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@
import com.fasterxml.jackson.annotation.JsonProperty;
import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.media.Schema.RequiredMode;
import io.swagger.v3.oas.models.SpecVersion;
import io.swagger.v3.oas.models.media.Schema;
import jakarta.validation.OverridesAttribute;
import jakarta.validation.constraints.DecimalMax;
Expand Down Expand Up @@ -296,7 +295,6 @@ else if (OPENAPI_STRING_TYPE.equals(type)) {
schema.setMaximum(BigDecimal.valueOf(((Range) anno).max()));
}
});
fixOAS31ExclusiveConstraints(schema);
if (schema!=null && annotatedNotNull(annotations)) {
String specVersion = schema.getSpecVersion().name();
if (!"V30".equals(specVersion)) {
Expand Down Expand Up @@ -563,30 +561,4 @@ private static JsonProperty getJsonProperty(Field f) {
if (g != null) return g.getAnnotation(JsonProperty.class);
return null;
}

/**
* Swagger-core 2.2.49 introduced so that {@link Positive} and {@link Negative} are introspected.
* It does not correctly use the fact that exclusiveMinimum/exclusiveMaximum are values in OAS31.
* <p>
* Tracked under <a href="https://github.com/swagger-api/swagger-core/issues/5170">swagger-core#5170</a>.
*
* @param schema the schema to fix
*/
public static void fixOAS31ExclusiveConstraints(Schema<?> schema) {
if (schema == null) {
return;
}
if (schema.getSpecVersion().equals(SpecVersion.V31)) {
if (schema.getExclusiveMaximumValue() != null && schema.getMaximum() != null) {
if (schema.getMaximum().compareTo(schema.getExclusiveMaximumValue()) == 0) {
schema.setMaximum(null);
}
}
if (schema.getExclusiveMinimumValue() != null && schema.getMinimum() != null) {
if (schema.getMinimum().compareTo(schema.getExclusiveMinimumValue()) == 0) {
schema.setMinimum(null);
}
}
}
}
}
35 changes: 0 additions & 35 deletions springdoc-openapi-starter-common/src/main/java/org/springdoc/core/utils/SpringDocUtils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@
import java.lang.annotation.Annotation;
import java.util.ArrayList;
import java.util.List;
import java.util.Set;
import java.util.function.Predicate;

import com.fasterxml.jackson.core.type.TypeReference;
Expand Down Expand Up @@ -180,40 +179,6 @@ else if (schema.getItems() != null && schema.getItems().getType() != null
if (schema.getProperties() != null) {
schema.getProperties().forEach((key, value) -> handleSchemaTypes(value));
}
fixNullOnlyAdditionalProperties(schema);
}
}

/**
* Fix additionalProperties incorrectly set to {"type": "null"} when @Nullable
* propagates from a Map field to its Object value type (resolved as "any type" = {}).
* <p>
* Tracked under <a href="https://github.com/swagger-api/swagger-core/issues/5115">swagger-core#5115</a>.
*
* @param schema the schema to fix
*/
public static void fixNullOnlyAdditionalProperties(Schema<?> schema) {
if (schema == null) {
return;
}
Object additionalProperties = schema.getAdditionalProperties();
if (additionalProperties instanceof Schema<?> addPropSchema) {
boolean isNullOnlyType = false;
Set<String> types = addPropSchema.getTypes();
if (types != null && types.size() == 1 && types.contains("null")) {
isNullOnlyType = true;
}
else if (types == null && "null".equals(addPropSchema.getType())) {
isNullOnlyType = true;
}
if (isNullOnlyType && addPropSchema.get$ref() == null
&& addPropSchema.getProperties() == null && addPropSchema.getFormat() == null) {
addPropSchema.setTypes(null);
addPropSchema.setType(null);
}
}
if (schema.getProperties() != null) {
schema.getProperties().values().forEach(prop -> fixNullOnlyAdditionalProperties((Schema<?>) prop));
}
}

Expand Down
Loading