Skip to content
This repository was archived by the owner on Mar 16, 2025. It is now read-only.

Commit 0327dba

Browse files
committed
cleanup
1 parent 64a9049 commit 0327dba

File tree

1 file changed

+8
-13
lines changed

1 file changed

+8
-13
lines changed

src/main/kotlin/io/openapiprocessor/core/converter/mapping/EndpointTypeMapping.kt

Lines changed: 8 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -6,31 +6,26 @@
66
package io.openapiprocessor.core.converter.mapping
77

88
/**
9-
* Used with {@link com.github.hauner.openapi.spring.converter.ApiOptions} to override parameter or
10-
* response type mappings on a single endpoint. It can also be used to add parameters that are not
11-
* defined in the api. For example to pass {@code javax.servlet.http.HttpServletRequest} to the
12-
* controller method.
13-
*
14-
* The {@code mappings} list can contain objects of the type
15-
* - {@link ParameterTypeMapping}
16-
* - {@link ResponseTypeMapping}
9+
* Used with [io.openapiprocessor.core.converter.ApiOptions] to store endpoint specific type
10+
* mappings. It can also be used to add parameters that are not defined in the api. For example
11+
* to pass a [javax.servlet.http.HttpServletRequest] to the*controller method.
1712
*/
1813
class EndpointTypeMapping @JvmOverloads constructor(
1914

2015
/**
21-
* Full path of the endpoint that is configured by this object.
16+
* full path of the endpoint that is configured by this object.
2217
*/
2318
var path: String,
2419

2520
/**
26-
* Provides type mappings for the endpoint.
21+
* provides type mappings for the endpoint.
2722
*/
28-
var typeMappings: List<Mapping> = emptyList(),
23+
val typeMappings: List<Mapping> = emptyList(),
2924

3025
/**
31-
* Exclude endpoint.
26+
* exclude endpoint.
3227
*/
33-
var exclude: Boolean = false
28+
val exclude: Boolean = false
3429

3530
): Mapping {
3631

0 commit comments

Comments
 (0)