Skip to content

Commit e2c0588

Browse files
committed
clean up
1 parent eeac69b commit e2c0588

6 files changed

Lines changed: 37 additions & 44 deletions

File tree

openapi-processor-core/src/main/kotlin/io/openapiprocessor/core/converter/SchemaInfo.kt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ import io.openapiprocessor.core.openapi.HttpMethod
1111
import io.openapiprocessor.core.openapi.Schema
1212
import io.openapiprocessor.core.support.capitalizeFirstChar
1313
import java.net.URI
14-
import io.openapiprocessor.core.openapi.RefResolver as ParserRefResolver
14+
import io.openapiprocessor.core.openapi.RefResolver as OpenApiRefResolver
1515

1616
/**
1717
* Helper for [DataTypeConverter]. Holds an OpenAPI schema with context information, e.g., name and
@@ -41,7 +41,7 @@ open class SchemaInfo(
4141
/**
4242
* resolver of $references.
4343
*/
44-
private val resolver: ParserRefResolver,
44+
private val resolver: OpenApiRefResolver,
4545

4646
/**
4747
* JSON path like location.

openapi-processor-core/src/main/kotlin/io/openapiprocessor/core/framework/Framework.kt

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ import io.openapiprocessor.core.model.RequestBody
99
import io.openapiprocessor.core.model.datatypes.AnnotationDataType
1010
import io.openapiprocessor.core.model.parameters.Parameter
1111
import io.openapiprocessor.core.model.datatypes.DataType
12-
import io.openapiprocessor.core.openapi.Parameter as ParserParameter
13-
import io.openapiprocessor.core.openapi.RequestBody as ParserRequestBody
12+
import io.openapiprocessor.core.openapi.Parameter as OpenApiParameter
13+
import io.openapiprocessor.core.openapi.RequestBody as OpenApiRequestBody
1414

1515
/**
1616
* factory for framework model objects.
@@ -24,7 +24,7 @@ interface Framework {
2424
* @param dataType data type of the parameter
2525
* @return a query {@link Parameter}
2626
*/
27-
fun createQueryParameter(parameter: ParserParameter, dataType: DataType): Parameter
27+
fun createQueryParameter(parameter: OpenApiParameter, dataType: DataType): Parameter
2828

2929
/**
3030
* create a model header parameter.
@@ -33,7 +33,7 @@ interface Framework {
3333
* @param dataType data type of the parameter
3434
* @return a header {@link Parameter}
3535
*/
36-
fun createHeaderParameter(parameter: ParserParameter, dataType: DataType): Parameter
36+
fun createHeaderParameter(parameter: OpenApiParameter, dataType: DataType): Parameter
3737

3838
/**
3939
* create a model cookie parameter.
@@ -42,7 +42,7 @@ interface Framework {
4242
* @param dataType data type of the parameter
4343
* @return a cookie {@link Parameter}
4444
*/
45-
fun createCookieParameter(parameter: ParserParameter, dataType: DataType): Parameter
45+
fun createCookieParameter(parameter: OpenApiParameter, dataType: DataType): Parameter
4646

4747
/**
4848
* create a model path parameter.
@@ -51,7 +51,7 @@ interface Framework {
5151
* @param dataType data type of the parameter
5252
* @return a path {@link Parameter}
5353
*/
54-
fun createPathParameter(parameter: ParserParameter, dataType: DataType): Parameter
54+
fun createPathParameter(parameter: OpenApiParameter, dataType: DataType): Parameter
5555

5656
/**
5757
* create a model multipart parameter.
@@ -60,7 +60,7 @@ interface Framework {
6060
* @param dataType data type of the parameter
6161
* @return a multipart {@link Parameter}
6262
*/
63-
fun createMultipartParameter(parameter: ParserParameter, dataType: DataType): Parameter
63+
fun createMultipartParameter(parameter: OpenApiParameter, dataType: DataType): Parameter
6464

6565
/**
6666
* create a model additional parameter.
@@ -70,7 +70,7 @@ interface Framework {
7070
* @param annotationDataType additional annotation
7171
* @return an additional {@link Parameter}
7272
*/
73-
fun createAdditionalParameter(parameter: ParserParameter, dataType: DataType,
73+
fun createAdditionalParameter(parameter: OpenApiParameter, dataType: DataType,
7474
annotationDataType: AnnotationDataType? = null): Parameter
7575

7676
/**
@@ -81,5 +81,5 @@ interface Framework {
8181
* @param dataType data type of the request body
8282
* @return an additional {@link RequestBody}
8383
*/
84-
fun createRequestBody(contentType: String, requestBody: ParserRequestBody, dataType: DataType): RequestBody
84+
fun createRequestBody(contentType: String, requestBody: OpenApiRequestBody, dataType: DataType): RequestBody
8585
}

openapi-processor-core/src/main/kotlin/io/openapiprocessor/core/framework/FrameworkBase.kt

Lines changed: 10 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -7,16 +7,10 @@ package io.openapiprocessor.core.framework
77

88
import io.openapiprocessor.core.model.RequestBody
99
import io.openapiprocessor.core.model.datatypes.AnnotationDataType
10-
import io.openapiprocessor.core.model.parameters.AdditionalParameter
11-
import io.openapiprocessor.core.model.parameters.CookieParameter
12-
import io.openapiprocessor.core.model.parameters.HeaderParameter
13-
import io.openapiprocessor.core.model.parameters.MultipartParameter
14-
import io.openapiprocessor.core.model.parameters.Parameter
15-
import io.openapiprocessor.core.model.parameters.PathParameter
16-
import io.openapiprocessor.core.model.parameters.QueryParameter
1710
import io.openapiprocessor.core.model.datatypes.DataType
18-
import io.openapiprocessor.core.openapi.Parameter as ParserParameter
19-
import io.openapiprocessor.core.openapi.RequestBody as ParserRequestBody
11+
import io.openapiprocessor.core.model.parameters.*
12+
import io.openapiprocessor.core.openapi.Parameter as OpenApiParameter
13+
import io.openapiprocessor.core.openapi.RequestBody as OpenApiRequestBody
2014

2115
/**
2216
* default implementation of [io.openapiprocessor.core.framework.Framework].
@@ -25,7 +19,7 @@ import io.openapiprocessor.core.openapi.RequestBody as ParserRequestBody
2519
*/
2620
open class FrameworkBase: Framework {
2721

28-
override fun createQueryParameter(parameter: ParserParameter, dataType: DataType): Parameter {
22+
override fun createQueryParameter(parameter: OpenApiParameter, dataType: DataType): Parameter {
2923
return QueryParameter(
3024
parameter.getName(),
3125
dataType,
@@ -35,7 +29,7 @@ open class FrameworkBase: Framework {
3529
)
3630
}
3731

38-
override fun createHeaderParameter(parameter: ParserParameter, dataType: DataType): Parameter {
32+
override fun createHeaderParameter(parameter: OpenApiParameter, dataType: DataType): Parameter {
3933
return HeaderParameter(
4034
parameter.getName(),
4135
dataType,
@@ -44,7 +38,7 @@ open class FrameworkBase: Framework {
4438
parameter.description)
4539
}
4640

47-
override fun createCookieParameter(parameter: ParserParameter, dataType: DataType): Parameter {
41+
override fun createCookieParameter(parameter: OpenApiParameter, dataType: DataType): Parameter {
4842
return CookieParameter(
4943
parameter.getName(),
5044
dataType,
@@ -53,7 +47,7 @@ open class FrameworkBase: Framework {
5347
parameter.description)
5448
}
5549

56-
override fun createPathParameter(parameter: ParserParameter, dataType: DataType): Parameter {
50+
override fun createPathParameter(parameter: OpenApiParameter, dataType: DataType): Parameter {
5751
return PathParameter(
5852
parameter.getName(),
5953
dataType,
@@ -62,7 +56,7 @@ open class FrameworkBase: Framework {
6256
parameter.description)
6357
}
6458

65-
override fun createMultipartParameter(parameter: ParserParameter, dataType: DataType): Parameter {
59+
override fun createMultipartParameter(parameter: OpenApiParameter, dataType: DataType): Parameter {
6660
return MultipartParameter(
6761
parameter.getName(),
6862
dataType,
@@ -71,7 +65,7 @@ open class FrameworkBase: Framework {
7165
parameter.description)
7266
}
7367

74-
override fun createAdditionalParameter(parameter: ParserParameter, dataType: DataType,
68+
override fun createAdditionalParameter(parameter: OpenApiParameter, dataType: DataType,
7569
annotationDataType: AnnotationDataType?): Parameter {
7670

7771
return AdditionalParameter(
@@ -83,7 +77,7 @@ open class FrameworkBase: Framework {
8377
parameter.description)
8478
}
8579

86-
override fun createRequestBody(contentType: String, requestBody: ParserRequestBody, dataType: DataType): RequestBody {
80+
override fun createRequestBody(contentType: String, requestBody: OpenApiRequestBody, dataType: DataType): RequestBody {
8781
return RequestBody(
8882
"body",
8983
contentType,

openapi-processor-core/src/main/kotlin/io/openapiprocessor/core/parser/openapi/Parser.kt

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -18,15 +18,15 @@ import io.openapiprocessor.jsonschema.schema.Output
1818
import io.openapiprocessor.jsonschema.schema.SchemaStore
1919
import io.openapiprocessor.jsonschema.validator.Validator
2020
import io.openapiprocessor.jsonschema.validator.ValidatorSettings
21+
import org.slf4j.Logger
22+
import org.slf4j.LoggerFactory
2123
import io.openapiparser.model.v30.OpenApi as OpenApi30
2224
import io.openapiparser.model.v31.OpenApi as OpenApi31
2325
import io.openapiparser.model.v32.OpenApi as OpenApi32
24-
import io.openapiprocessor.core.openapi.OpenApi as ParserOpenApi
26+
import io.openapiprocessor.core.openapi.OpenApi as OpenApiOpenApi
2527
import io.openapiprocessor.core.parser.openapi.v30.OpenApi as ParserOpenApi30
2628
import io.openapiprocessor.core.parser.openapi.v31.OpenApi as ParserOpenApi31
2729
import io.openapiprocessor.core.parser.openapi.v32.OpenApi as ParserOpenApi32
28-
import org.slf4j.Logger
29-
import org.slf4j.LoggerFactory
3030

3131
/**
3232
* openapi-parser
@@ -35,7 +35,7 @@ class Parser {
3535
private val log: Logger = LoggerFactory.getLogger(this.javaClass.name)
3636

3737

38-
fun parse(apiPath: String): ParserOpenApi {
38+
fun parse(apiPath: String): OpenApiOpenApi {
3939
val reader = UriReader ()
4040
val converter = JacksonConverter ()
4141
val loader = DocumentLoader (reader, converter)
@@ -62,17 +62,17 @@ class Parser {
6262
}
6363
}
6464

65-
private fun createApi32(result: OpenApiResult): ParserOpenApi {
65+
private fun createApi32(result: OpenApiResult): OpenApiOpenApi {
6666
val model = result.getModel(OpenApi32::class.java)
6767
return ParserOpenApi32(model)
6868
}
6969

70-
private fun createApi31(result: OpenApiResult): ParserOpenApi {
70+
private fun createApi31(result: OpenApiResult): OpenApiOpenApi {
7171
val model = result.getModel(OpenApi31::class.java)
7272
return ParserOpenApi31(model)
7373
}
7474

75-
private fun createApi30(result: OpenApiResult): ParserOpenApi {
75+
private fun createApi30(result: OpenApiResult): OpenApiOpenApi {
7676
val model = result.getModel(OpenApi30::class.java)
7777
return ParserOpenApi30(model)
7878
}

openapi-processor-core/src/test/kotlin/io/openapiprocessor/core/support/OpenApiParser.kt

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,16 +8,16 @@ package io.openapiprocessor.core.support
88
import io.openapiprocessor.core.parser.ParserType
99
import io.openapiprocessor.core.parser.openapi.Parser
1010
import io.openapiprocessor.test.stream.Memory
11-
import io.openapiprocessor.core.openapi.OpenApi as ParserOpenApi
11+
import io.openapiprocessor.core.openapi.OpenApi as OpenApiOpenApi
1212
import io.openapiprocessor.test.parser.openapi4j.parse as parseWithOpenApi4j
1313
import io.openapiprocessor.test.parser.swagger.parse as parseWithSwagger
1414

1515
/**
1616
* OpenAPI parser to read YAML from memory using the given parser.
1717
*
18-
* extract individual Schemas with the get...Schema() functions on the [ParserOpenApi] result.
18+
* extract individual Schemas with the get...Schema() functions on the [OpenApiOpenApi] result.
1919
*/
20-
fun parseApi(apiYaml: String, parserType: ParserType = ParserType.INTERNAL): ParserOpenApi {
20+
fun parseApi(apiYaml: String, parserType: ParserType = ParserType.INTERNAL): OpenApiOpenApi {
2121
return when (parserType) {
2222
ParserType.SWAGGER -> parseWithSwagger(apiYaml)
2323
ParserType.OPENAPI4J -> parseWithOpenApi4j(apiYaml)
@@ -36,7 +36,7 @@ fun parseApi(
3636
""",
3737
body: String,
3838
parserType: ParserType = ParserType.INTERNAL
39-
): ParserOpenApi {
39+
): OpenApiOpenApi {
4040
val merged = (
4141
header.trimMargin()
4242
+ body.trimIndent()
@@ -47,17 +47,17 @@ fun parseApi(
4747
fun parseApiBody(
4848
body: String,
4949
parserType: ParserType = ParserType.INTERNAL
50-
): ParserOpenApi {
50+
): OpenApiOpenApi {
5151
return parseApi(body, parserType)
5252
}
5353

5454
/** groovy support */
5555

56-
fun parseApiBody(body: String): ParserOpenApi {
56+
fun parseApiBody(body: String): OpenApiOpenApi {
5757
return parseApi(body = body)
5858
}
5959

60-
fun parseWithInternal(yaml: String): ParserOpenApi {
60+
fun parseWithInternal(yaml: String): OpenApiOpenApi {
6161
Memory.add("openapi.yaml", yaml)
6262
return Parser().parse("memory:openapi.yaml")
6363
}

openapi-processor-core/src/test/kotlin/io/openapiprocessor/core/support/Schema.kt

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ package io.openapiprocessor.core.support
77

88
import io.openapiprocessor.core.openapi.Schema
99
import java.net.URI
10-
import io.openapiprocessor.core.openapi.Schema as ParserSchema
10+
import io.openapiprocessor.core.openapi.Schema as OpenApiSchema
1111

1212
/**
1313
* simple Schema implementation for testing
@@ -16,8 +16,7 @@ import io.openapiprocessor.core.openapi.Schema as ParserSchema
1616
class Schema(
1717
private val schemaType: String? = null,
1818
private val schemaProperties: Map<String, Schema> = mapOf()
19-
20-
) : ParserSchema {
19+
) : OpenApiSchema {
2120

2221
override fun getType(): String? {
2322
return schemaType

0 commit comments

Comments
 (0)