Skip to content

Commit 1230add

Browse files
bnasslahsenbnasslahsen
committed
code review
1 parent 25f9058 commit 1230add

File tree

26 files changed

+96
-96
lines changed

26 files changed

+96
-96
lines changed

‎springdoc-openapi-starter-common/src/main/java/org/springdoc/api/AbstractOpenApiResource.java

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -175,7 +175,7 @@ public abstract class AbstractOpenApiResource extends SpecFilter {
175175
/**
176176
* The Open api customisers.
177177
*/
178-
private final Optional<List<OpenApiCustomizer>> openApiCustomisers;
178+
private final Optional<List<OpenApiCustomizer>> openApiCustomizers;
179179

180180
/**
181181
* The Operation customizers.
@@ -229,7 +229,7 @@ public abstract class AbstractOpenApiResource extends SpecFilter {
229229
* @param responseBuilder the response builder
230230
* @param operationParser the operation parser
231231
* @param operationCustomizers the operation customizers
232-
* @param openApiCustomisers the open api customisers
232+
* @param openApiCustomizers the open api customisers
233233
* @param methodFilters the method filters
234234
* @param springDocConfigProperties the spring doc config properties
235235
* @param springDocProviders the spring doc providers
@@ -238,7 +238,7 @@ protected AbstractOpenApiResource(String groupName, ObjectFactory<OpenAPIService
238238
AbstractRequestService requestBuilder,
239239
GenericResponseService responseBuilder, OperationService operationParser,
240240
Optional<List<OperationCustomizer>> operationCustomizers,
241-
Optional<List<OpenApiCustomizer>> openApiCustomisers,
241+
Optional<List<OpenApiCustomizer>> openApiCustomizers,
242242
Optional<List<OpenApiMethodFilter>> methodFilters,
243243
SpringDocConfigProperties springDocConfigProperties, SpringDocProviders springDocProviders) {
244244
super();
@@ -248,13 +248,13 @@ protected AbstractOpenApiResource(String groupName, ObjectFactory<OpenAPIService
248248
this.requestBuilder = requestBuilder;
249249
this.responseBuilder = responseBuilder;
250250
this.operationParser = operationParser;
251-
this.openApiCustomisers = openApiCustomisers;
251+
this.openApiCustomizers = openApiCustomizers;
252252
this.methodFilters = methodFilters;
253253
this.springDocProviders = springDocProviders;
254254
//add the default customizers
255-
Map<String, OpenApiCustomizer> existingOpenApiCustomisers = openAPIService.getContext().getBeansOfType(OpenApiCustomizer.class);
256-
if (!CollectionUtils.isEmpty(existingOpenApiCustomisers) && existingOpenApiCustomisers.containsKey(LINKS_SCHEMA_CUSTOMISER))
257-
openApiCustomisers.ifPresent(openApiCustomisersList -> openApiCustomisersList.add(existingOpenApiCustomisers.get(LINKS_SCHEMA_CUSTOMISER)));
255+
Map<String, OpenApiCustomizer> existingOpenApiCustomizers = openAPIService.getContext().getBeansOfType(OpenApiCustomizer.class);
256+
if (!CollectionUtils.isEmpty(existingOpenApiCustomizers) && existingOpenApiCustomizers.containsKey(LINKS_SCHEMA_CUSTOMISER))
257+
openApiCustomizers.ifPresent(openApiCustomizersList -> openApiCustomizersList.add(existingOpenApiCustomizers.get(LINKS_SCHEMA_CUSTOMISER)));
258258
this.springDocConfigProperties = springDocConfigProperties;
259259
operationCustomizers.ifPresent(customizers -> customizers.removeIf(Objects::isNull));
260260
this.operationCustomizers = operationCustomizers;
@@ -360,7 +360,7 @@ protected synchronized OpenAPI getOpenApi(Locale locale) {
360360
}
361361

362362
openApiLocaleCustomizers.values().forEach(openApiLocaleCustomizer -> openApiLocaleCustomizer.customise(openApi, finalLocale));
363-
openApiCustomisers.ifPresent(apiCustomisers -> apiCustomisers.forEach(openApiCustomiser -> openApiCustomiser.customise(openApi)));
363+
openApiCustomizers.ifPresent(apiCustomisers -> apiCustomisers.forEach(openApiCustomizer -> openApiCustomizer.customise(openApi)));
364364
if (!CollectionUtils.isEmpty(openApi.getServers()) && !openApi.getServers().equals(serversCopy))
365365
openAPIService.setServersPresent(true);
366366

‎springdoc-openapi-starter-common/src/main/java/org/springdoc/core/configuration/SpringDocConfiguration.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -465,7 +465,7 @@ OperationCustomizer actuatorCustomizer() {
465465
@Bean
466466
@Lazy(false)
467467
@ConditionalOnManagementPort(ManagementPortType.SAME)
468-
OpenApiCustomizer actuatorOpenApiCustomiser(WebEndpointProperties webEndpointProperties) {
468+
OpenApiCustomizer actuatorOpenApiCustomizer(WebEndpointProperties webEndpointProperties) {
469469
return new ActuatorOpenApiCustomizer(webEndpointProperties);
470470
}
471471

‎springdoc-openapi-starter-common/src/main/java/org/springdoc/core/configurer/SpringdocActuatorBeanFactoryConfigurer.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -70,16 +70,16 @@ public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory)
7070

7171
List<GroupedOpenApi> newGroups = new ArrayList<>();
7272

73-
ActuatorOpenApiCustomizer actuatorOpenApiCustomiser = new ActuatorOpenApiCustomizer(webEndpointProperties);
74-
beanFactory.registerSingleton("actuatorOpenApiCustomiser", actuatorOpenApiCustomiser);
73+
ActuatorOpenApiCustomizer actuatorOpenApiCustomizer = new ActuatorOpenApiCustomizer(webEndpointProperties);
74+
beanFactory.registerSingleton("actuatorOpenApiCustomizer", actuatorOpenApiCustomizer);
7575
ActuatorOperationCustomizer actuatorCustomizer = new ActuatorOperationCustomizer();
7676
beanFactory.registerSingleton("actuatorCustomizer", actuatorCustomizer);
7777

7878
GroupedOpenApi actuatorGroup = GroupedOpenApi.builder().group(ACTUATOR_DEFAULT_GROUP)
7979
.pathsToMatch(webEndpointProperties.getBasePath() + ALL_PATTERN)
8080
.pathsToExclude(webEndpointProperties.getBasePath() + HEALTH_PATTERN)
8181
.addOperationCustomizer(actuatorCustomizer)
82-
.addOpenApiCustomiser(actuatorOpenApiCustomiser)
82+
.addOpenApiCustomizer(actuatorOpenApiCustomizer)
8383
.build();
8484
// Add the actuator group
8585
newGroups.add(actuatorGroup);

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

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ public class GroupedOpenApi {
4949
/**
5050
* The Open api customisers.
5151
*/
52-
private final List<OpenApiCustomizer> openApiCustomisers;
52+
private final List<OpenApiCustomizer> openApiCustomizers;
5353

5454
/**
5555
* The Operation customizers.
@@ -110,7 +110,7 @@ private GroupedOpenApi(Builder builder) {
110110
this.headersToMatch = builder.headersToMatch;
111111
this.packagesToExclude = builder.packagesToExclude;
112112
this.pathsToExclude = builder.pathsToExclude;
113-
this.openApiCustomisers = Objects.requireNonNull(builder.openApiCustomisers);
113+
this.openApiCustomizers = Objects.requireNonNull(builder.openApiCustomizers);
114114
this.operationCustomizers = Objects.requireNonNull(builder.operationCustomizers);
115115
this.openApiMethodFilters = Objects.requireNonNull(builder.methodFilters);
116116
if (CollectionUtils.isEmpty(this.pathsToMatch)
@@ -120,10 +120,10 @@ private GroupedOpenApi(Builder builder) {
120120
&& CollectionUtils.isEmpty(this.headersToMatch)
121121
&& CollectionUtils.isEmpty(this.pathsToExclude)
122122
&& CollectionUtils.isEmpty(this.packagesToExclude)
123-
&& CollectionUtils.isEmpty(openApiCustomisers)
123+
&& CollectionUtils.isEmpty(openApiCustomizers)
124124
&& CollectionUtils.isEmpty(operationCustomizers)
125125
&& CollectionUtils.isEmpty(openApiMethodFilters))
126-
throw new IllegalStateException("Packages to scan or paths to filter or openApiCustomisers/operationCustomizers can not be all null for the group:" + this.group);
126+
throw new IllegalStateException("Packages to scan or paths to filter or openApiCustomizers/operationCustomizers can not be all null for the group:" + this.group);
127127
}
128128

129129
/**
@@ -212,8 +212,8 @@ public List<String> getPathsToExclude() {
212212
*
213213
* @return the open api customisers
214214
*/
215-
public List<OpenApiCustomizer> getOpenApiCustomisers() {
216-
return openApiCustomisers;
215+
public List<OpenApiCustomizer> getOpenApiCustomizers() {
216+
return openApiCustomizers;
217217
}
218218

219219
/**
@@ -242,7 +242,7 @@ public static class Builder {
242242
/**
243243
* The Open api customisers.
244244
*/
245-
private final List<OpenApiCustomizer> openApiCustomisers = new ArrayList<>();
245+
private final List<OpenApiCustomizer> openApiCustomizers = new ArrayList<>();
246246

247247
/**
248248
* The Operation customizers.
@@ -392,11 +392,11 @@ public Builder packagesToExclude(String... packagesToExclude) {
392392
/**
393393
* Add open api customiser builder.
394394
*
395-
* @param openApiCustomiser the open api customiser
395+
* @param openApiCustomizer the open api customiser
396396
* @return the builder
397397
*/
398-
public Builder addOpenApiCustomiser(OpenApiCustomizer openApiCustomiser) {
399-
this.openApiCustomisers.add(openApiCustomiser);
398+
public Builder addOpenApiCustomizer(OpenApiCustomizer openApiCustomizer) {
399+
this.openApiCustomizers.add(openApiCustomizer);
400400
return this;
401401
}
402402

‎springdoc-openapi-starter-common/src/test/java/org/springdoc/api/AbstractOpenApiResourceTest.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,7 @@ void preLoadingModeShouldNotOverwriteServers() throws InterruptedException {
187187

188188
String customUrl = "https://custom.com";
189189
String generatedUrl = "https://generated.com";
190-
OpenApiCustomizer openApiCustomiser = openApi -> openApi.setServers(singletonList(new Server().url(customUrl)));
190+
OpenApiCustomizer openApiCustomizer = openApi -> openApi.setServers(singletonList(new Server().url(customUrl)));
191191
SpringDocConfigProperties properties = new SpringDocConfigProperties();
192192
properties.setPreLoadingEnabled(true);
193193

@@ -198,7 +198,7 @@ void preLoadingModeShouldNotOverwriteServers() throws InterruptedException {
198198
responseBuilder,
199199
operationParser,
200200
Optional.empty(),
201-
Optional.of(singletonList(openApiCustomiser)),
201+
Optional.of(singletonList(openApiCustomizer)),
202202
Optional.empty(),
203203
properties, springDocProviders
204204
);
@@ -218,8 +218,8 @@ void preLoadingModeShouldNotOverwriteServers() throws InterruptedException {
218218

219219
private static class EmptyPathsOpenApiResource extends AbstractOpenApiResource {
220220

221-
EmptyPathsOpenApiResource(String groupName, ObjectFactory<OpenAPIService> openAPIBuilderObjectFactory, AbstractRequestService requestBuilder, GenericResponseService responseBuilder, OperationService operationParser, Optional<List<OperationCustomizer>> operationCustomizers, Optional<List<OpenApiCustomizer>> openApiCustomisers, Optional<List<OpenApiMethodFilter>> methodFilters, SpringDocConfigProperties springDocConfigProperties, SpringDocProviders springDocProviders) {
222-
super(groupName, openAPIBuilderObjectFactory, requestBuilder, responseBuilder, operationParser, operationCustomizers, openApiCustomisers, methodFilters, springDocConfigProperties, springDocProviders);
221+
EmptyPathsOpenApiResource(String groupName, ObjectFactory<OpenAPIService> openAPIBuilderObjectFactory, AbstractRequestService requestBuilder, GenericResponseService responseBuilder, OperationService operationParser, Optional<List<OperationCustomizer>> operationCustomizers, Optional<List<OpenApiCustomizer>> openApiCustomizers, Optional<List<OpenApiMethodFilter>> methodFilters, SpringDocConfigProperties springDocConfigProperties, SpringDocProviders springDocProviders) {
222+
super(groupName, openAPIBuilderObjectFactory, requestBuilder, responseBuilder, operationParser, operationCustomizers, openApiCustomizers, methodFilters, springDocConfigProperties, springDocProviders);
223223
}
224224

225225
@Override

‎springdoc-openapi-starter-webflux-api/src/main/java/org/springdoc/webflux/api/MultipleOpenApiResource.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ private OpenApiResource buildWebFluxOpenApiResource(GroupedOpenApi item) {
139139
responseBuilder,
140140
operationParser,
141141
Optional.of(item.getOperationCustomizers()),
142-
Optional.of(item.getOpenApiCustomisers()),
142+
Optional.of(item.getOpenApiCustomizers()),
143143
Optional.of(item.getOpenApiMethodFilters()),
144144
springDocConfigProperties,
145145
springDocProviders
@@ -151,7 +151,7 @@ private OpenApiResource buildWebFluxOpenApiResource(GroupedOpenApi item) {
151151
responseBuilder,
152152
operationParser,
153153
Optional.of(item.getOperationCustomizers()),
154-
Optional.of(item.getOpenApiCustomisers()),
154+
Optional.of(item.getOpenApiCustomizers()),
155155
Optional.of(item.getOpenApiMethodFilters()),
156156
springDocConfigProperties,
157157
springDocProviders);

‎springdoc-openapi-starter-webflux-api/src/main/java/org/springdoc/webflux/api/OpenApiActuatorResource.java

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -69,13 +69,13 @@ public class OpenApiActuatorResource extends OpenApiResource {
6969
* @param responseBuilder the response builder
7070
* @param operationParser the operation parser
7171
* @param operationCustomizers the operation customizers
72-
* @param openApiCustomisers the open api customisers
72+
* @param openApiCustomizers the open api customisers
7373
* @param methodFilters the method filters
7474
* @param springDocConfigProperties the spring doc config properties
7575
* @param springDocProviders the spring doc providers
7676
*/
77-
public OpenApiActuatorResource(String groupName, ObjectFactory<OpenAPIService> openAPIBuilderObjectFactory, AbstractRequestService requestBuilder, GenericResponseService responseBuilder, OperationService operationParser, Optional<List<OperationCustomizer>> operationCustomizers, Optional<List<OpenApiCustomizer>> openApiCustomisers, Optional<List<OpenApiMethodFilter>> methodFilters, SpringDocConfigProperties springDocConfigProperties, SpringDocProviders springDocProviders) {
78-
super(groupName, openAPIBuilderObjectFactory, requestBuilder, responseBuilder, operationParser, operationCustomizers, openApiCustomisers, methodFilters, springDocConfigProperties, springDocProviders);
77+
public OpenApiActuatorResource(String groupName, ObjectFactory<OpenAPIService> openAPIBuilderObjectFactory, AbstractRequestService requestBuilder, GenericResponseService responseBuilder, OperationService operationParser, Optional<List<OperationCustomizer>> operationCustomizers, Optional<List<OpenApiCustomizer>> openApiCustomizers, Optional<List<OpenApiMethodFilter>> methodFilters, SpringDocConfigProperties springDocConfigProperties, SpringDocProviders springDocProviders) {
78+
super(groupName, openAPIBuilderObjectFactory, requestBuilder, responseBuilder, operationParser, operationCustomizers, openApiCustomizers, methodFilters, springDocConfigProperties, springDocProviders);
7979
}
8080

8181
/**
@@ -86,13 +86,13 @@ public OpenApiActuatorResource(String groupName, ObjectFactory<OpenAPIService> o
8686
* @param responseBuilder the response builder
8787
* @param operationParser the operation parser
8888
* @param operationCustomizers the operation customizers
89-
* @param openApiCustomisers the open api customisers
89+
* @param openApiCustomizers the open api customisers
9090
* @param methodFilters the method filters
9191
* @param springDocConfigProperties the spring doc config properties
9292
* @param springDocProviders the spring doc providers
9393
*/
94-
public OpenApiActuatorResource(ObjectFactory<OpenAPIService> openAPIBuilderObjectFactory, AbstractRequestService requestBuilder, GenericResponseService responseBuilder, OperationService operationParser, Optional<List<OperationCustomizer>> operationCustomizers, Optional<List<OpenApiCustomizer>> openApiCustomisers, Optional<List<OpenApiMethodFilter>> methodFilters, SpringDocConfigProperties springDocConfigProperties, SpringDocProviders springDocProviders) {
95-
super(openAPIBuilderObjectFactory, requestBuilder, responseBuilder, operationParser, operationCustomizers, openApiCustomisers, methodFilters, springDocConfigProperties, springDocProviders);
94+
public OpenApiActuatorResource(ObjectFactory<OpenAPIService> openAPIBuilderObjectFactory, AbstractRequestService requestBuilder, GenericResponseService responseBuilder, OperationService operationParser, Optional<List<OperationCustomizer>> operationCustomizers, Optional<List<OpenApiCustomizer>> openApiCustomizers, Optional<List<OpenApiMethodFilter>> methodFilters, SpringDocConfigProperties springDocConfigProperties, SpringDocProviders springDocProviders) {
95+
super(openAPIBuilderObjectFactory, requestBuilder, responseBuilder, operationParser, operationCustomizers, openApiCustomizers, methodFilters, springDocConfigProperties, springDocProviders);
9696
}
9797

9898
/**

‎springdoc-openapi-starter-webflux-api/src/main/java/org/springdoc/webflux/api/OpenApiResource.java

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -77,19 +77,19 @@ public abstract class OpenApiResource extends AbstractOpenApiResource {
7777
* @param responseBuilder the response builder
7878
* @param operationParser the operation parser
7979
* @param operationCustomizers the operation customizers
80-
* @param openApiCustomisers the open api customisers
80+
* @param openApiCustomizers the open api customisers
8181
* @param methodFilters the method filters
8282
* @param springDocConfigProperties the spring doc config properties
8383
* @param springDocProviders the spring doc providers
8484
*/
8585
public OpenApiResource(String groupName, ObjectFactory<OpenAPIService> openAPIBuilderObjectFactory, AbstractRequestService requestBuilder,
8686
GenericResponseService responseBuilder, OperationService operationParser,
8787
Optional<List<OperationCustomizer>> operationCustomizers,
88-
Optional<List<OpenApiCustomizer>> openApiCustomisers,
88+
Optional<List<OpenApiCustomizer>> openApiCustomizers,
8989
Optional<List<OpenApiMethodFilter>> methodFilters,
9090
SpringDocConfigProperties springDocConfigProperties,
9191
SpringDocProviders springDocProviders) {
92-
super(groupName, openAPIBuilderObjectFactory, requestBuilder, responseBuilder, operationParser, operationCustomizers, openApiCustomisers, methodFilters, springDocConfigProperties, springDocProviders);
92+
super(groupName, openAPIBuilderObjectFactory, requestBuilder, responseBuilder, operationParser, operationCustomizers, openApiCustomizers, methodFilters, springDocConfigProperties, springDocProviders);
9393
}
9494

9595
/**
@@ -100,19 +100,19 @@ public OpenApiResource(String groupName, ObjectFactory<OpenAPIService> openAPIBu
100100
* @param responseBuilder the response builder
101101
* @param operationParser the operation parser
102102
* @param operationCustomizers the operation customizers
103-
* @param openApiCustomisers the open api customisers
103+
* @param openApiCustomizers the open api customisers
104104
* @param methodFilters the method filters
105105
* @param springDocConfigProperties the spring doc config properties
106106
* @param springDocProviders the spring doc providers
107107
*/
108108
public OpenApiResource(ObjectFactory<OpenAPIService> openAPIBuilderObjectFactory, AbstractRequestService requestBuilder,
109109
GenericResponseService responseBuilder, OperationService operationParser,
110110
Optional<List<OperationCustomizer>> operationCustomizers,
111-
Optional<List<OpenApiCustomizer>> openApiCustomisers,
111+
Optional<List<OpenApiCustomizer>> openApiCustomizers,
112112
Optional<List<OpenApiMethodFilter>> methodFilters,
113113
SpringDocConfigProperties springDocConfigProperties,
114114
SpringDocProviders springDocProviders) {
115-
super(DEFAULT_GROUP_NAME, openAPIBuilderObjectFactory, requestBuilder, responseBuilder, operationParser, operationCustomizers, openApiCustomisers, methodFilters, springDocConfigProperties, springDocProviders);
115+
super(DEFAULT_GROUP_NAME, openAPIBuilderObjectFactory, requestBuilder, responseBuilder, operationParser, operationCustomizers, openApiCustomizers, methodFilters, springDocConfigProperties, springDocProviders);
116116
}
117117

118118

0 commit comments

Comments
 (0)