Skip to content

Commit c523445

Browse files
bnasslahsenbnasslahsen
committed
code review
1 parent cb743b3 commit c523445

File tree

16 files changed

+33
-43
lines changed

16 files changed

+33
-43
lines changed

‎springdoc-openapi-common/src/main/java/org/springdoc/core/GenericParameterService.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -369,11 +369,11 @@ private Schema calculateRequestBodySchema(Components components, ParameterInfo p
369369
}
370370

371371
if (requestBodyInfo.getMergedSchema() != null) {
372-
requestBodyInfo.getMergedSchema().addProperties(paramName, schemaN);
372+
requestBodyInfo.getMergedSchema().addProperty(paramName, schemaN);
373373
schemaN = requestBodyInfo.getMergedSchema();
374374
}
375375
else if (parameterInfo.isRequestPart() || schemaN instanceof FileSchema || schemaN instanceof ArraySchema && ((ArraySchema) schemaN).getItems() instanceof FileSchema) {
376-
schemaN = new ObjectSchema().addProperties(paramName, schemaN);
376+
schemaN = new ObjectSchema().addProperty(paramName, schemaN);
377377
requestBodyInfo.setMergedSchema(schemaN);
378378
}
379379
else

‎springdoc-openapi-common/src/main/java/org/springdoc/core/GroupedOpenApi.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -472,7 +472,7 @@ public GroupedOpenApi build() {
472472
* @param openApiCustomizerCollection the open api customizer collection
473473
* @return the grouped open api
474474
*/
475-
public GroupedOpenApi addAllOpenApiCustomizer(Collection openApiCustomizerCollection) {
475+
public GroupedOpenApi addAllOpenApiCustomizer(Collection<? extends OpenApiCustomiser> openApiCustomizerCollection) {
476476
this.openApiCustomisers.addAll(openApiCustomizerCollection);
477477
Collections.reverse(openApiCustomisers);
478478
return this;
@@ -484,7 +484,7 @@ public GroupedOpenApi addAllOpenApiCustomizer(Collection openApiCustomizerCollec
484484
* @param operationCustomizerCollection the operation customizer collection
485485
* @return the grouped open api
486486
*/
487-
public GroupedOpenApi addAllOperationCustomizer(Collection operationCustomizerCollection) {
487+
public GroupedOpenApi addAllOperationCustomizer(Collection<? extends OperationCustomizer> operationCustomizerCollection) {
488488
this.operationCustomizers.addAll(operationCustomizerCollection);
489489
Collections.reverse(operationCustomizers);
490490
return this;
@@ -496,7 +496,7 @@ public GroupedOpenApi addAllOperationCustomizer(Collection operationCustomizerCo
496496
* @param openApiMethodFilterCollection the open api method filter collection
497497
* @return the grouped open api
498498
*/
499-
public GroupedOpenApi addAllOpenApiMethodFilter(Collection openApiMethodFilterCollection) {
499+
public GroupedOpenApi addAllOpenApiMethodFilter(Collection<? extends OpenApiMethodFilter> openApiMethodFilterCollection) {
500500
this.openApiMethodFilters.addAll(openApiMethodFilterCollection);
501501
Collections.reverse(openApiMethodFilters);
502502
return this;

‎springdoc-openapi-common/src/main/java/org/springdoc/core/RequestBodyInfo.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ public void setMergedSchema(Schema mergedSchema) {
8888
public void addProperties(String paramName, Schema schemaN) {
8989
if (mergedSchema == null)
9090
mergedSchema = new ObjectSchema();
91-
mergedSchema.addProperties(paramName, schemaN);
91+
mergedSchema.addProperty(paramName, schemaN);
9292
}
9393

9494
}

‎springdoc-openapi-common/src/main/java/org/springdoc/core/SecurityService.java

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -106,8 +106,7 @@ else if (!StringUtils.isBlank(oAuthFlow.authorizationUrl()) || !StringUtils.isBl
106106
* @return the boolean
107107
*/
108108
private static boolean isEmpty(OAuthScope[] scopes) {
109-
boolean result = scopes == null || scopes.length == 0;
110-
return result;
109+
return scopes == null || scopes.length == 0;
111110
}
112111

113112
/**

‎springdoc-openapi-common/src/main/java/org/springdoc/core/customizers/GlobalOpenApiCustomizer.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
* customize Open api on default OpenAPI description and groups.
2828
*
2929
* @author christophejan
30-
* @see OpenApiCustomiserto customize default OpenAPI description but not groups
30+
* @see OpenApiCustomiser customize default OpenAPI description but not groups
3131
*/
3232
public interface GlobalOpenApiCustomizer extends OpenApiCustomiser {
3333
}

‎springdoc-openapi-common/src/main/java/org/springdoc/core/fn/builders/schema/Builder.java

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -268,7 +268,7 @@ public class Builder {
268268
* AdditionalPropertiesValue.USE_ADDITIONAL_PROPERTIES_ANNOTATION: resolve from @Content.additionalPropertiesSchema
269269
*
270270
*/
271-
private final AdditionalPropertiesValue additionalProperties = AdditionalPropertiesValue.USE_ADDITIONAL_PROPERTIES_ANNOTATION;
271+
private AdditionalPropertiesValue additionalProperties = AdditionalPropertiesValue.USE_ADDITIONAL_PROPERTIES_ANNOTATION;
272272

273273
/**
274274
* Instantiates a new Schema builder.
@@ -681,6 +681,17 @@ public Builder extensions(org.springdoc.core.fn.builders.extension.Builder exten
681681
return this;
682682
}
683683

684+
/**
685+
* Additional properties builder.
686+
*
687+
* @param additionalProperties the additional properties
688+
* @return the builder
689+
*/
690+
public Builder additionalProperties(AdditionalPropertiesValue additionalProperties) {
691+
this.additionalProperties = additionalProperties;
692+
return this;
693+
}
694+
684695
/**
685696
* Build schema.
686697
*

‎springdoc-openapi-common/src/main/java/org/springdoc/core/providers/ObjectMapperProvider.java

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -45,19 +45,12 @@ public class ObjectMapperProvider {
4545
*/
4646
private final ObjectMapper yamlMapper;
4747

48-
/**
49-
* The Spring doc config properties.
50-
*/
51-
private final SpringDocConfigProperties springDocConfigProperties;
52-
53-
5448
/**
5549
* Instantiates a new Spring doc object mapper.
5650
*
5751
* @param springDocConfigProperties the spring doc config properties
5852
*/
5953
public ObjectMapperProvider(SpringDocConfigProperties springDocConfigProperties) {
60-
this.springDocConfigProperties = springDocConfigProperties;
6154
OpenApiVersion openApiVersion = springDocConfigProperties.getApiDocs().getVersion();
6255
if (openApiVersion == OpenApiVersion.OPENAPI_3_1) {
6356
jsonMapper = Json31.mapper();

‎springdoc-openapi-data-rest/src/main/java/org/springdoc/data/rest/DataRestHalProvider.java

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -44,11 +44,6 @@ public class DataRestHalProvider extends HateoasHalProvider {
4444
*/
4545
private final Optional<RepositoryRestConfiguration> repositoryRestConfigurationOptional;
4646

47-
/**
48-
* The Object mapper provider.
49-
*/
50-
private final ObjectMapperProvider objectMapperProvider;
51-
5247
/**
5348
* Instantiates a new Data rest hal provider.
5449
*
@@ -60,7 +55,6 @@ public DataRestHalProvider(Optional<RepositoryRestConfiguration> repositoryRestC
6055
ObjectMapperProvider objectMapperProvider) {
6156
super(hateoasPropertiesOptional, objectMapperProvider);
6257
this.repositoryRestConfigurationOptional = repositoryRestConfigurationOptional;
63-
this.objectMapperProvider = objectMapperProvider;
6458
}
6559

6660
@PostConstruct

‎springdoc-openapi-data-rest/src/main/java/org/springdoc/data/rest/core/DataRestResponseService.java

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -262,8 +262,7 @@ else if (parameterizedType.getActualTypeArguments()[0] instanceof ParameterizedT
262262
return getTypeForParameterizedType(requestMethod, dataRestRepository, returnedEntityType, parameterizedType);
263263
}
264264
else if (parameterizedType.getActualTypeArguments()[0] instanceof WildcardType) {
265-
Type type = getTypeForWildcardType(requestMethod, dataRestRepository, returnedEntityType, parameterizedType);
266-
return type;
265+
return getTypeForWildcardType(requestMethod, dataRestRepository, returnedEntityType, parameterizedType);
267266
}
268267
return null;
269268
}

‎springdoc-openapi-data-rest/src/main/java/org/springdoc/data/rest/customisers/QuerydslPredicateOperationCustomizer.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@
4545
import org.apache.commons.lang3.reflect.FieldUtils;
4646
import org.slf4j.Logger;
4747
import org.slf4j.LoggerFactory;
48-
import org.springdoc.core.customizers.OperationCustomizer;
48+
import org.springdoc.core.customizers.GlobalOperationCustomizer;
4949

5050
import org.springframework.core.MethodParameter;
5151
import org.springframework.data.querydsl.binding.QuerydslBinderCustomizer;
@@ -63,7 +63,7 @@
6363
* @author Gibah Joseph Email: gibahjoe@gmail.com Mar, 2020
6464
*/
6565
@SuppressWarnings("unchecked")
66-
public class QuerydslPredicateOperationCustomizer implements OperationCustomizer {
66+
public class QuerydslPredicateOperationCustomizer implements GlobalOperationCustomizer {
6767

6868
/**
6969
* The constant LOGGER.

‎springdoc-openapi-data-rest/src/main/java/org/springdoc/data/rest/utils/SpringDocDataRestUtils.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -235,9 +235,9 @@ private void updateRequestBodySchemaProperties(String key, Schema referencedSche
235235
String propId = entry.getKey();
236236
if (entityInoMap.containsKey(key) && entityInoMap.get(key).getAssociationsFields().contains(propId)) {
237237
if (entry.getValue() instanceof ArraySchema)
238-
referencedSchema.addProperties(propId, new ArraySchema().items(new StringSchema()));
238+
referencedSchema.addProperty(propId, new ArraySchema().items(new StringSchema()));
239239
else
240-
referencedSchema.addProperties(propId, new StringSchema());
240+
referencedSchema.addProperty(propId, new StringSchema());
241241
}
242242
}
243243
}

‎springdoc-openapi-hateoas/src/main/java/org/springdoc/hateoas/HateoasHalProvider.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ public class HateoasHalProvider {
4545
/**
4646
* The Object mapper provider.
4747
*/
48-
private final ObjectMapperProvider objectMapperProvider;
48+
protected final ObjectMapperProvider objectMapperProvider;
4949

5050
/**
5151
* Instantiates a new Hateoas hal provider.

‎springdoc-openapi-hateoas/src/main/java/org/springdoc/hateoas/SpringDocHateoasConfiguration.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
import com.fasterxml.jackson.core.JsonGenerator;
2828
import com.fasterxml.jackson.databind.SerializerProvider;
2929
import org.springdoc.core.SpringDocConfigProperties;
30-
import org.springdoc.core.customizers.OpenApiCustomiser;
30+
import org.springdoc.core.customizers.GlobalOpenApiCustomizer;
3131
import org.springdoc.core.providers.ObjectMapperProvider;
3232
import org.springdoc.hateoas.converters.CollectionModelContentConverter;
3333
import org.springdoc.hateoas.converters.OpenApiHateoasLinksCustomiser;
@@ -98,7 +98,7 @@ CollectionModelContentConverter collectionModelContentConverter(HateoasHalProvid
9898
@Bean(LINKS_SCHEMA_CUSTOMISER)
9999
@ConditionalOnMissingBean
100100
@Lazy(false)
101-
OpenApiCustomiser linksSchemaCustomiser(HateoasHalProvider halProvider, SpringDocConfigProperties springDocConfigProperties, ObjectMapperProvider objectMapperProvider) {
101+
GlobalOpenApiCustomizer linksSchemaCustomiser(HateoasHalProvider halProvider, SpringDocConfigProperties springDocConfigProperties, ObjectMapperProvider objectMapperProvider) {
102102
if (!halProvider.isHalEnabled()) {
103103
return openApi -> {
104104
};

‎springdoc-openapi-hateoas/src/main/java/org/springdoc/hateoas/converters/OpenApiHateoasLinksCustomiser.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,15 +32,15 @@
3232
import io.swagger.v3.oas.models.media.ObjectSchema;
3333
import io.swagger.v3.oas.models.media.StringSchema;
3434
import org.springdoc.core.SpringDocConfigProperties;
35-
import org.springdoc.core.customizers.OpenApiCustomiser;
35+
import org.springdoc.core.customizers.GlobalOpenApiCustomizer;
3636

3737
import org.springframework.hateoas.Link;
3838

3939
/**
4040
* The type Open api hateoas links customiser.
4141
* @author bnasslahsen
4242
*/
43-
public class OpenApiHateoasLinksCustomiser extends SpecFilter implements OpenApiCustomiser {
43+
public class OpenApiHateoasLinksCustomiser extends SpecFilter implements GlobalOpenApiCustomizer {
4444

4545
/**
4646
* The Spring doc config properties.

‎springdoc-openapi-kotlin/src/main/java/org/springdoc/kotlin/SpringDocKotlinConfiguration.java

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -45,21 +45,15 @@
4545
@ConditionalOnProperty(name = SPRINGDOC_ENABLED, matchIfMissing = true)
4646
public class SpringDocKotlinConfiguration {
4747

48-
/**
49-
* The Object mapper provider.
50-
*/
51-
private final ObjectMapperProvider objectMapperProvider;
52-
5348
/**
5449
* Instantiates a new Spring doc kotlin configuration.
5550
*
5651
* @param objectMapperProvider the object mapper provider
5752
*/
5853
public SpringDocKotlinConfiguration(ObjectMapperProvider objectMapperProvider) {
59-
this.objectMapperProvider = objectMapperProvider;
6054
getConfig().addRequestWrapperToIgnore(Continuation.class)
6155
.addDeprecatedType(Deprecated.class);
62-
objectMapperProvider.jsonMapper().registerModule(new KotlinModule());
56+
objectMapperProvider.jsonMapper().registerModule( new KotlinModule.Builder().build());
6357
}
6458

6559
/**

‎springdoc-openapi-security/src/main/java/org/springdoc/security/SpringDocSecurityConfiguration.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -134,8 +134,8 @@ OpenApiCustomiser springSecurityLoginEndpointCustomiser(ApplicationContext appli
134134
UsernamePasswordAuthenticationFilter usernamePasswordAuthenticationFilter = optionalFilter.get();
135135
Operation operation = new Operation();
136136
Schema<?> schema = new ObjectSchema()
137-
.addProperties(usernamePasswordAuthenticationFilter.getUsernameParameter(), new StringSchema())
138-
.addProperties(usernamePasswordAuthenticationFilter.getPasswordParameter(), new StringSchema());
137+
.addProperty(usernamePasswordAuthenticationFilter.getUsernameParameter(), new StringSchema())
138+
.addProperty(usernamePasswordAuthenticationFilter.getPasswordParameter(), new StringSchema());
139139
RequestBody requestBody = new RequestBody().content(new Content().addMediaType(org.springframework.http.MediaType.APPLICATION_JSON_VALUE, new MediaType().schema(schema)));
140140
operation.requestBody(requestBody);
141141
ApiResponses apiResponses = new ApiResponses();

0 commit comments

Comments
 (0)