Skip to content

Commit 4d68351

Browse files
bnasslahsenbnasslahsen
committed
code review
2 parents ac31b6d + c567f67 commit 4d68351

File tree

16 files changed

+159
-159
lines changed

16 files changed

+159
-159
lines changed

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ public class DataRestHalProvider extends HateoasHalProvider {
4848
/**
4949
* Instantiates a new Data rest hal provider.
5050
*
51-
* @param repositoryRestConfigurationOptional the repository rest configuration optional
51+
* @param repositoryRestConfigurationOptional the repository rest configuration optional
5252
* @param hateoasPropertiesOptional the hateoas properties optional
5353
*/
5454
public DataRestHalProvider(Optional<RepositoryRestConfiguration> repositoryRestConfigurationOptional,Optional<HateoasProperties> hateoasPropertiesOptional) {

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

+29-29
Original file line numberDiff line numberDiff line change
@@ -82,8 +82,8 @@ public class DataRestOperationService {
8282
/**
8383
* Instantiates a new Data rest operation builder.
8484
*
85-
* @param dataRestRequestService the data rest request builder
86-
* @param tagsBuilder the tags builder
85+
* @param dataRestRequestService the data rest request builder
86+
* @param tagsBuilder the tags builder
8787
* @param dataRestResponseService the data rest response builder
8888
*/
8989
public DataRestOperationService(DataRestRequestService dataRestRequestService, DataRestTagsService tagsBuilder,
@@ -96,15 +96,15 @@ public DataRestOperationService(DataRestRequestService dataRestRequestService, D
9696
/**
9797
* Build operation operation.
9898
*
99-
* @param handlerMethod the handler method
100-
* @param dataRestRepository the repository data rest
101-
* @param openAPI the open api
102-
* @param requestMethod the request method
103-
* @param operationPath the operation path
104-
* @param methodAttributes the method attributes
105-
* @param resourceMetadata the resource metadata
106-
* @param methodResourceMapping the method resource mapping
107-
* @param controllerType the controller type
99+
* @param handlerMethod the handler method
100+
* @param dataRestRepository the repository data rest
101+
* @param openAPI the open api
102+
* @param requestMethod the request method
103+
* @param operationPath the operation path
104+
* @param methodAttributes the method attributes
105+
* @param resourceMetadata the resource metadata
106+
* @param methodResourceMapping the method resource mapping
107+
* @param controllerType the controller type
108108
* @return the operation
109109
*/
110110
public Operation buildOperation(HandlerMethod handlerMethod, DataRestRepository dataRestRepository,
@@ -127,13 +127,13 @@ else if (ControllerType.SEARCH.equals(controllerType)) {
127127
/**
128128
* Build entity operation operation.
129129
*
130-
* @param handlerMethod the handler method
131-
* @param dataRestRepository the repository data rest
132-
* @param openAPI the open api
133-
* @param requestMethod the request method
134-
* @param operationPath the operation path
135-
* @param methodAttributes the method attributes
136-
* @param resourceMetadata the resource metadata
130+
* @param handlerMethod the handler method
131+
* @param dataRestRepository the repository data rest
132+
* @param openAPI the open api
133+
* @param requestMethod the request method
134+
* @param operationPath the operation path
135+
* @param methodAttributes the method attributes
136+
* @param resourceMetadata the resource metadata
137137
* @return the operation
138138
*/
139139
private Operation buildEntityOperation(HandlerMethod handlerMethod, DataRestRepository dataRestRepository,
@@ -154,12 +154,12 @@ private Operation buildEntityOperation(HandlerMethod handlerMethod, DataRestRepo
154154
/**
155155
* Build search operation operation.
156156
*
157-
* @param handlerMethod the handler method
158-
* @param dataRestRepository the repository data rest
159-
* @param openAPI the open api
160-
* @param requestMethod the request method
161-
* @param methodAttributes the method attributes
162-
* @param methodResourceMapping the method resource mapping
157+
* @param handlerMethod the handler method
158+
* @param dataRestRepository the repository data rest
159+
* @param openAPI the open api
160+
* @param requestMethod the request method
161+
* @param methodAttributes the method attributes
162+
* @param methodResourceMapping the method resource mapping
163163
* @return the operation
164164
*/
165165
private Operation buildSearchOperation(HandlerMethod handlerMethod, DataRestRepository dataRestRepository,
@@ -201,9 +201,9 @@ private Operation buildSearchOperation(HandlerMethod handlerMethod, DataRestRepo
201201
/**
202202
* Init operation operation.
203203
*
204-
* @param handlerMethod the handler method
205-
* @param domainType the domain type
206-
* @param requestMethod the request method
204+
* @param handlerMethod the handler method
205+
* @param domainType the domain type
206+
* @param requestMethod the request method
207207
* @return the operation
208208
*/
209209
private Operation initOperation(HandlerMethod handlerMethod, Class<?> domainType, RequestMethod requestMethod) {
@@ -221,8 +221,8 @@ private Operation initOperation(HandlerMethod handlerMethod, Class<?> domainType
221221
/**
222222
* Add operation description.
223223
*
224-
* @param operation the operation
225-
* @param requestMethod the request method
224+
* @param operation the operation
225+
* @param requestMethod the request method
226226
* @param entity the entity
227227
*/
228228
private void addOperationDescription(Operation operation, RequestMethod requestMethod, String entity) {

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ public class DataRestRepository {
5252
/**
5353
* Instantiates a new Data rest repository.
5454
*
55-
* @param domainType the domain type
55+
* @param domainType the domain type
5656
* @param repositoryType the repository type
5757
*/
5858
public DataRestRepository(Class<?> domainType, Class<?> repositoryType) {

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

+23-23
Original file line numberDiff line numberDiff line change
@@ -86,9 +86,9 @@ public class DataRestRequestService {
8686
/**
8787
* Instantiates a new Data rest request builder.
8888
*
89-
* @param localSpringDocParameterNameDiscoverer the local spring doc parameter name discoverer
90-
* @param parameterBuilder the parameter builder
91-
* @param requestBodyService the request body builder
89+
* @param localSpringDocParameterNameDiscoverer the local spring doc parameter name discoverer
90+
* @param parameterBuilder the parameter builder
91+
* @param requestBodyService the request body builder
9292
* @param requestBuilder the request builder
9393
*/
9494
public DataRestRequestService(LocalVariableTableParameterNameDiscoverer localSpringDocParameterNameDiscoverer, GenericParameterService parameterBuilder,
@@ -102,12 +102,12 @@ public DataRestRequestService(LocalVariableTableParameterNameDiscoverer localSpr
102102
/**
103103
* Build parameters.
104104
*
105-
* @param domainType the domain type
106-
* @param openAPI the open api
107-
* @param handlerMethod the handler method
108-
* @param requestMethod the request method
109-
* @param methodAttributes the method attributes
110-
* @param operation the operation
105+
* @param domainType the domain type
106+
* @param openAPI the open api
107+
* @param handlerMethod the handler method
108+
* @param requestMethod the request method
109+
* @param methodAttributes the method attributes
110+
* @param operation the operation
111111
* @param resourceMetadata the resource metadata
112112
*/
113113
public void buildParameters(Class<?> domainType, OpenAPI openAPI, HandlerMethod handlerMethod, RequestMethod requestMethod, MethodAttributes methodAttributes, Operation operation, ResourceMetadata resourceMetadata) {
@@ -127,12 +127,12 @@ public void buildParameters(Class<?> domainType, OpenAPI openAPI, HandlerMethod
127127
/**
128128
* Build common parameters.
129129
*
130-
* @param domainType the domain type
131-
* @param openAPI the open api
132-
* @param requestMethod the request method
133-
* @param methodAttributes the method attributes
134-
* @param operation the operation
135-
* @param pNames the p names
130+
* @param domainType the domain type
131+
* @param openAPI the open api
132+
* @param requestMethod the request method
133+
* @param methodAttributes the method attributes
134+
* @param operation the operation
135+
* @param pNames the p names
136136
* @param parameters the parameters
137137
*/
138138
public void buildCommonParameters(Class<?> domainType, OpenAPI openAPI, RequestMethod requestMethod, MethodAttributes methodAttributes, Operation operation, String[] pNames, MethodParameter[] parameters) {
@@ -168,7 +168,7 @@ else if (methodParameter.getParameterAnnotation(BackendId.class) != null) {
168168
/**
169169
* Is param to ignore boolean.
170170
*
171-
* @param methodParameter the method parameter
171+
* @param methodParameter the method parameter
172172
* @return the boolean
173173
*/
174174
private boolean isParamToIgnore(MethodParameter methodParameter) {
@@ -180,12 +180,12 @@ private boolean isParamToIgnore(MethodParameter methodParameter) {
180180
/**
181181
* Add parameters.
182182
*
183-
* @param openAPI the open api
184-
* @param requestMethod the request method
185-
* @param methodAttributes the method attributes
186-
* @param operation the operation
187-
* @param methodParameter the method parameter
188-
* @param parameterInfo the parameter info
183+
* @param openAPI the open api
184+
* @param requestMethod the request method
185+
* @param methodAttributes the method attributes
186+
* @param operation the operation
187+
* @param methodParameter the method parameter
188+
* @param parameterInfo the parameter info
189189
* @param parameter the parameter
190190
*/
191191
private void addParameters(OpenAPI openAPI, RequestMethod requestMethod, MethodAttributes methodAttributes, Operation operation, MethodParameter methodParameter, ParameterInfo parameterInfo, Parameter parameter) {
@@ -209,7 +209,7 @@ else if (!RequestMethod.GET.equals(requestMethod)) {
209209
/**
210210
* Is header to ignore boolean.
211211
*
212-
* @param methodParameter the method parameter
212+
* @param methodParameter the method parameter
213213
* @return the boolean
214214
*/
215215
private boolean isHeaderToIgnore(MethodParameter methodParameter) {

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

+23-23
Original file line numberDiff line numberDiff line change
@@ -73,11 +73,11 @@ public DataRestResponseService(GenericResponseService genericResponseService) {
7373
/**
7474
* Build search response.
7575
*
76-
* @param operation the operation
77-
* @param handlerMethod the handler method
78-
* @param openAPI the open api
79-
* @param methodResourceMapping the method resource mapping
80-
* @param domainType the domain type
76+
* @param operation the operation
77+
* @param handlerMethod the handler method
78+
* @param openAPI the open api
79+
* @param methodResourceMapping the method resource mapping
80+
* @param domainType the domain type
8181
* @param methodAttributes the method attributes
8282
*/
8383
public void buildSearchResponse(Operation operation, HandlerMethod handlerMethod, OpenAPI openAPI,
@@ -97,12 +97,12 @@ public void buildSearchResponse(Operation operation, HandlerMethod handlerMethod
9797
/**
9898
* Build entity response.
9999
*
100-
* @param operation the operation
101-
* @param handlerMethod the handler method
102-
* @param openAPI the open api
103-
* @param requestMethod the request method
104-
* @param operationPath the operation path
105-
* @param domainType the domain type
100+
* @param operation the operation
101+
* @param handlerMethod the handler method
102+
* @param openAPI the open api
103+
* @param requestMethod the request method
104+
* @param operationPath the operation path
105+
* @param domainType the domain type
106106
* @param methodAttributes the method attributes
107107
*/
108108
public void buildEntityResponse(Operation operation, HandlerMethod handlerMethod, OpenAPI openAPI, RequestMethod requestMethod,
@@ -121,9 +121,9 @@ public void buildEntityResponse(Operation operation, HandlerMethod handlerMethod
121121
/**
122122
* Add response.
123123
*
124-
* @param requestMethod the request method
125-
* @param operationPath the operation path
126-
* @param apiResponses the api responses
124+
* @param requestMethod the request method
125+
* @param operationPath the operation path
126+
* @param apiResponses the api responses
127127
* @param apiResponse the api response
128128
*/
129129
private void addResponse(RequestMethod requestMethod, String operationPath, ApiResponses apiResponses, ApiResponse apiResponse) {
@@ -157,9 +157,9 @@ private void addResponse(RequestMethod requestMethod, String operationPath, ApiR
157157
/**
158158
* Find search return type type.
159159
*
160-
* @param handlerMethod the handler method
161-
* @param methodResourceMapping the method resource mapping
162-
* @param domainType the domain type
160+
* @param handlerMethod the handler method
161+
* @param methodResourceMapping the method resource mapping
162+
* @param domainType the domain type
163163
* @return the type
164164
*/
165165
private Type findSearchReturnType(HandlerMethod handlerMethod, MethodResourceMapping methodResourceMapping, Class<?> domainType) {
@@ -184,8 +184,8 @@ else if (!ClassUtils.isPrimitiveOrWrapper(domainType)) {
184184
/**
185185
* Gets type.
186186
*
187-
* @param returnType the return type
188-
* @param domainType the domain type
187+
* @param returnType the return type
188+
* @param domainType the domain type
189189
* @return the type
190190
*/
191191
private Type getType(Type returnType, Class<?> domainType) {
@@ -233,9 +233,9 @@ else if ((CollectionModel.class.equals(parameterizedType.getRawType())
233233
/**
234234
* Resolve generic type type.
235235
*
236-
* @param container the container
237-
* @param generic the generic
238-
* @param domainType the domain type
236+
* @param container the container
237+
* @param generic the generic
238+
* @param domainType the domain type
239239
* @return the type
240240
*/
241241
private Type resolveGenericType(Class<?> container, Class<?> generic, Class<?> domainType) {
@@ -246,7 +246,7 @@ private Type resolveGenericType(Class<?> container, Class<?> generic, Class<?> d
246246
/**
247247
* Add response 200.
248248
*
249-
* @param apiResponses the api responses
249+
* @param apiResponses the api responses
250250
* @param apiResponse the api response
251251
*/
252252
private void addResponse200(ApiResponses apiResponses, ApiResponse apiResponse) {

0 commit comments

Comments
 (0)