Skip to content

Commit 789509e

Browse files
ozscheygeSushruth-Godugunuariooz
authored
Minor cleanup as follow-up to #135 (#136)
* use regex to extract parameters from path in OpenApi 2.0 generator * use regex to extract parameters from path in OpenApi 3.0 generator * fixed typo in multi param test in OpenAPI 2.0 generator added OpenAPI 3.0 multi param test * fix typo * Cleanup unneeded setup data and empty line * Cleanup import and whitespace * Fix whitespace and lint * Lint fix Co-authored-by: Sushruth Godugunuari <[email protected]> Co-authored-by: ooz <[email protected]>
1 parent e1794c4 commit 789509e

File tree

3 files changed

+9
-27
lines changed

3 files changed

+9
-27
lines changed

restdocs-api-spec-openapi-generator/src/main/kotlin/com/epages/restdocs/apispec/openapi2/OpenApi20Generator.kt

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ import com.epages.restdocs.apispec.model.Oauth2Configuration
88
import com.epages.restdocs.apispec.model.ParameterDescriptor
99
import com.epages.restdocs.apispec.model.ResourceModel
1010
import com.epages.restdocs.apispec.model.ResponseModel
11+
import com.epages.restdocs.apispec.model.Schema
1112
import com.epages.restdocs.apispec.model.SecurityRequirements
1213
import com.epages.restdocs.apispec.model.SecurityType
13-
import com.epages.restdocs.apispec.model.Schema
1414
import com.fasterxml.jackson.module.kotlin.readValue
1515
import io.swagger.models.Info
1616
import io.swagger.models.Model
@@ -34,7 +34,6 @@ import io.swagger.models.properties.PropertyBuilder
3434
import io.swagger.util.Json
3535
import java.util.Comparator.comparing
3636
import java.util.Comparator.comparingInt
37-
import java.util.regex.Pattern
3837

3938
object OpenApi20Generator {
4039

@@ -325,7 +324,7 @@ object OpenApi20Generator {
325324

326325
private fun extractPathParameters(resourceModel: ResourceModel): List<PathParameter> {
327326
val pathParameterNames = PATH_PARAMETER_PATTERN.findAll(resourceModel.request.path)
328-
.map { matchResult -> matchResult.groupValues[1] }
327+
.map { matchResult -> matchResult.groupValues[1] }
329328
.toList()
330329

331330
return pathParameterNames.map { parameterName ->

restdocs-api-spec-openapi3-generator/src/main/kotlin/com/epages/restdocs/apispec/openapi3/OpenApi3Generator.kt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -346,7 +346,7 @@ object OpenApi3Generator {
346346

347347
private fun extractPathParameters(resourceModel: ResourceModel): List<PathParameter> {
348348
val pathParameterNames = PATH_PARAMETER_PATTERN.findAll(resourceModel.request.path)
349-
.map { matchResult -> matchResult.groupValues[1] }
349+
.map { matchResult -> matchResult.groupValues[1] }
350350
.toList()
351351

352352
return pathParameterNames.map { parameterName ->

restdocs-api-spec-openapi3-generator/src/test/kotlin/com/epages/restdocs/apispec/openapi3/OpenApi3GeneratorTest.kt

Lines changed: 6 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
package com.epages.restdocs.apispec.openapi3
22

3+
import com.epages.restdocs.apispec.model.Attributes
34
import com.epages.restdocs.apispec.model.FieldDescriptor
45
import com.epages.restdocs.apispec.model.HTTPMethod
56
import com.epages.restdocs.apispec.model.HeaderDescriptor
@@ -8,10 +9,9 @@ import com.epages.restdocs.apispec.model.ParameterDescriptor
89
import com.epages.restdocs.apispec.model.RequestModel
910
import com.epages.restdocs.apispec.model.ResourceModel
1011
import com.epages.restdocs.apispec.model.ResponseModel
12+
import com.epages.restdocs.apispec.model.Schema
1113
import com.epages.restdocs.apispec.model.SecurityRequirements
1214
import com.epages.restdocs.apispec.model.SecurityType
13-
import com.epages.restdocs.apispec.model.Schema
14-
import com.epages.restdocs.apispec.model.Attributes
1515
import com.jayway.jsonpath.Configuration
1616
import com.jayway.jsonpath.DocumentContext
1717
import com.jayway.jsonpath.JsonPath
@@ -178,13 +178,12 @@ class OpenApi3GeneratorTest {
178178
}
179179

180180
@Test
181-
fun `should extract multiple parameters when seperated by delimiter`(){
181+
fun `should extract multiple parameters when seperated by delimiter`() {
182182
givenResourceWithMultiplePathParameters()
183183

184184
whenOpenApiObjectGenerated()
185185

186186
thenMultiplePathParametersExist()
187-
188187
}
189188

190189
fun thenGetProductByIdOperationIsValid() {
@@ -719,30 +718,14 @@ class OpenApi3GeneratorTest {
719718
)
720719
}
721720

722-
private fun getProductRequestWithMultiplePathParameters (getSecurityRequirement: () -> SecurityRequirements = ::getOAuth2SecurityRequirement): RequestModel {
721+
private fun getProductRequestWithMultiplePathParameters(getSecurityRequirement: () -> SecurityRequirements = ::getOAuth2SecurityRequirement): RequestModel {
723722
return RequestModel(
724723
path = "/products/{id}-{subId}",
725724
method = HTTPMethod.GET,
726725
securityRequirements = getSecurityRequirement(),
727-
headers = listOf(
728-
HeaderDescriptor(
729-
name = "Authorization",
730-
description = "Access token",
731-
type = "string",
732-
optional = false,
733-
example = "some example"
734-
)
735-
),
726+
headers = emptyList(),
736727
pathParameters = emptyList(),
737-
requestParameters = listOf(
738-
ParameterDescriptor(
739-
name = "locale",
740-
description = "Localizes the product fields to the given locale code",
741-
type = "STRING",
742-
optional = true,
743-
ignored = false
744-
)
745-
),
728+
requestParameters = emptyList(),
746729
requestFields = listOf()
747730
)
748731
}

0 commit comments

Comments
 (0)