Skip to content

Commit 5b2f47b

Browse files
ozscheygeooz
ozscheyge
and
ooz
authored
Fix use of default keyword as field/method name (#191)
* Replace default method with defaultValue for HeaderDescriptorWithType and ParameterDescriptorWithType * Rename default to _default for ResourceModel types * Use defaultValue instead of _default * Use defaultValue instead of _default * Use defaultValue instead of _default * Use defaultValue instead of _default Co-authored-by: ooz <ooz@users.noreply.github.com>
1 parent 8bf9e1f commit 5b2f47b

7 files changed

Lines changed: 37 additions & 34 deletions

File tree

‎restdocs-api-spec-model/src/main/kotlin/com/epages/restdocs/apispec/model/ResourceModel.kt‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ interface AbstractParameterDescriptor {
6262
val name: String
6363
val description: String
6464
val type: String
65-
val default: Any?
65+
val defaultValue: Any?
6666
val optional: Boolean
6767
val attributes: Attributes
6868
}
@@ -71,7 +71,7 @@ data class HeaderDescriptor(
7171
override val name: String,
7272
override val description: String,
7373
override val type: String,
74-
override val default: Any? = null,
74+
override val defaultValue: Any? = null,
7575
override val optional: Boolean,
7676
val example: String? = null,
7777
override val attributes: Attributes = Attributes()
@@ -101,7 +101,7 @@ data class ParameterDescriptor(
101101
override val name: String,
102102
override val description: String,
103103
override val type: String,
104-
override val default: Any? = null,
104+
override val defaultValue: Any? = null,
105105
override val optional: Boolean,
106106
val ignored: Boolean,
107107
override val attributes: Attributes = Attributes()

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -417,7 +417,7 @@ object OpenApi20Generator {
417417
name = parameterDescriptor.name
418418
description = parameterDescriptor.description
419419
type = parameterDescriptor.type.toLowerCase()
420-
default = parameterDescriptor.default
420+
default = parameterDescriptor.defaultValue
421421
}
422422
}
423423

@@ -435,7 +435,7 @@ object OpenApi20Generator {
435435
description = parameterDescriptor.description
436436
required = parameterDescriptor.optional.not()
437437
type = parameterDescriptor.type.toLowerCase()
438-
default = parameterDescriptor.default
438+
default = parameterDescriptor.defaultValue
439439
}
440440
}
441441

@@ -445,7 +445,7 @@ object OpenApi20Generator {
445445
description = parameterDescriptor.description
446446
required = parameterDescriptor.optional.not()
447447
type = parameterDescriptor.type.toLowerCase()
448-
default = parameterDescriptor.default
448+
default = parameterDescriptor.defaultValue
449449
}
450450
}
451451

@@ -455,7 +455,7 @@ object OpenApi20Generator {
455455
description = headerDescriptor.description
456456
required = headerDescriptor.optional.not()
457457
type = headerDescriptor.type.toLowerCase()
458-
default = headerDescriptor.default
458+
default = headerDescriptor.defaultValue
459459
}
460460
}
461461

‎restdocs-api-spec-openapi-generator/src/test/kotlin/com/epages/restdocs/apispec/openapi2/OpenApi20GeneratorTest.kt‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -453,7 +453,7 @@ class OpenApi20GeneratorTest {
453453
val parameter = findParameterByTypeAndName(parameters, type, parameterDescriptor.name)
454454
then(parameter).isNotNull
455455
then(parameter!!.description).isEqualTo(parameterDescriptor.description)
456-
then(parameter!!.default).isEqualTo(parameterDescriptor.default)
456+
then(parameter!!.default).isEqualTo(parameterDescriptor.defaultValue)
457457
}
458458

459459
private fun findParameterByTypeAndName(parameters: List<AbstractSerializableParameter<*>>, type: String, name: String): AbstractSerializableParameter<*>? {
@@ -938,14 +938,14 @@ class OpenApi20GeneratorTest {
938938
description = "a header string parameter",
939939
type = "STRING",
940940
optional = true,
941-
default = "a default header value"
941+
defaultValue = "a default header value"
942942
),
943943
HeaderDescriptor(
944944
name = "X-SOME-BOOLEAN",
945945
description = "a header boolean parameter",
946946
type = "BOOLEAN",
947947
optional = true,
948-
default = true
948+
defaultValue = true
949949
)
950950
),
951951
requestParameters = listOf(
@@ -955,31 +955,31 @@ class OpenApi20GeneratorTest {
955955
type = "BOOLEAN",
956956
optional = true,
957957
ignored = false,
958-
default = true
958+
defaultValue = true
959959
),
960960
ParameterDescriptor(
961961
name = "stringParameter",
962962
description = "a string parameter",
963963
type = "STRING",
964964
optional = true,
965965
ignored = false,
966-
default = "a default value"
966+
defaultValue = "a default value"
967967
),
968968
ParameterDescriptor(
969969
name = "numberParameter",
970970
description = "a number parameter",
971971
type = "NUMBER",
972972
optional = true,
973973
ignored = false,
974-
default = 1.0
974+
defaultValue = 1.0
975975
),
976976
ParameterDescriptor(
977977
name = "integerParameter",
978978
description = "a integer parameter",
979979
type = "INTEGER",
980980
optional = true,
981981
ignored = false,
982-
default = 2L
982+
defaultValue = 2L
983983
)
984984
)
985985
)

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -443,10 +443,10 @@ object OpenApi3Generator {
443443

444444
private fun simpleTypeToSchema(parameterDescriptor: AbstractParameterDescriptor): Schema<*>? {
445445
return when (parameterDescriptor.type.toLowerCase()) {
446-
SimpleType.BOOLEAN.name.toLowerCase() -> BooleanSchema().apply { this._default(parameterDescriptor.default?.let { it as Boolean }) }
447-
SimpleType.STRING.name.toLowerCase() -> StringSchema().apply { this._default(parameterDescriptor.default?.let { it as String }) }
448-
SimpleType.NUMBER.name.toLowerCase() -> NumberSchema().apply { this._default(parameterDescriptor.default?.let { it as BigDecimal }) }
449-
SimpleType.INTEGER.name.toLowerCase() -> IntegerSchema().apply { this._default(parameterDescriptor.default?.let { it as Int }) }
446+
SimpleType.BOOLEAN.name.toLowerCase() -> BooleanSchema().apply { this._default(parameterDescriptor.defaultValue?.let { it as Boolean }) }
447+
SimpleType.STRING.name.toLowerCase() -> StringSchema().apply { this._default(parameterDescriptor.defaultValue?.let { it as String }) }
448+
SimpleType.NUMBER.name.toLowerCase() -> NumberSchema().apply { this._default(parameterDescriptor.defaultValue?.let { it as BigDecimal }) }
449+
SimpleType.INTEGER.name.toLowerCase() -> IntegerSchema().apply { this._default(parameterDescriptor.defaultValue?.let { it as Int }) }
450450
else -> throw IllegalArgumentException("Unknown type '${parameterDescriptor.type}'")
451451
}
452452
}

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

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1077,28 +1077,28 @@ class OpenApi3GeneratorTest {
10771077
description = "a header boolean parameter",
10781078
type = "BOOLEAN",
10791079
optional = true,
1080-
default = true
1080+
defaultValue = true
10811081
),
10821082
HeaderDescriptor(
10831083
name = "X-SOME-STRING",
10841084
description = "a header string parameter",
10851085
type = "STRING",
10861086
optional = true,
1087-
default = "a default header value"
1087+
defaultValue = "a default header value"
10881088
),
10891089
HeaderDescriptor(
10901090
name = "X-SOME-NUMBER",
10911091
description = "a header number parameter",
10921092
type = "NUMBER",
10931093
optional = true,
1094-
default = 1.toBigDecimal()
1094+
defaultValue = 1.toBigDecimal()
10951095
),
10961096
HeaderDescriptor(
10971097
name = "X-SOME-INTEGER",
10981098
description = "a header integer parameter",
10991099
type = "INTEGER",
11001100
optional = true,
1101-
default = 2
1101+
defaultValue = 2
11021102
)
11031103
),
11041104
requestParameters = listOf(
@@ -1108,31 +1108,31 @@ class OpenApi3GeneratorTest {
11081108
type = "BOOLEAN",
11091109
optional = true,
11101110
ignored = false,
1111-
default = true
1111+
defaultValue = true
11121112
),
11131113
ParameterDescriptor(
11141114
name = "stringParameter",
11151115
description = "a string parameter",
11161116
type = "STRING",
11171117
optional = true,
11181118
ignored = false,
1119-
default = "a default value"
1119+
defaultValue = "a default value"
11201120
),
11211121
ParameterDescriptor(
11221122
name = "numberParameter",
11231123
description = "a number parameter",
11241124
type = "NUMBER",
11251125
optional = true,
11261126
ignored = false,
1127-
default = 1.toBigDecimal()
1127+
defaultValue = 1.toBigDecimal()
11281128
),
11291129
ParameterDescriptor(
11301130
name = "integerParameter",
11311131
description = "a integer parameter",
11321132
type = "INTEGER",
11331133
optional = true,
11341134
ignored = false,
1135-
default = 2
1135+
defaultValue = 2
11361136
)
11371137
)
11381138
)
@@ -1147,7 +1147,7 @@ class OpenApi3GeneratorTest {
11471147
type = "BOOLEAN",
11481148
optional = true,
11491149
ignored = false,
1150-
default = "not a boolean value"
1150+
defaultValue = "not a boolean value"
11511151
)
11521152
)
11531153
)
@@ -1161,7 +1161,7 @@ class OpenApi3GeneratorTest {
11611161
description = "a header boolean parameter",
11621162
type = "BOOLEAN",
11631163
optional = true,
1164-
default = "not a boolean value"
1164+
defaultValue = "not a boolean value"
11651165
)
11661166
)
11671167
)

‎restdocs-api-spec/src/main/kotlin/com/epages/restdocs/apispec/ResourceSnippetParameters.kt‎

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

33
import com.epages.restdocs.apispec.SimpleType.STRING
4+
import com.fasterxml.jackson.annotation.JsonProperty
45
import org.springframework.restdocs.headers.HeaderDescriptor
56
import org.springframework.restdocs.hypermedia.LinkDescriptor
67
import org.springframework.restdocs.payload.FieldDescriptor
@@ -98,13 +99,14 @@ class HeaderDescriptorWithType(val name: String) : AbstractDescriptor<HeaderDesc
9899
var optional: Boolean = false
99100
private set
100101

101-
var default: Any? = null
102+
@JsonProperty("default")
103+
var defaultValue: Any? = null
102104

103105
var example: String? = null
104106

105107
fun type(type: SimpleType) = apply { this.type = type }
106108

107-
fun default(default: Any) = apply { this.default = default }
109+
fun defaultValue(defaultValue: Any) = apply { this.defaultValue = defaultValue }
108110

109111
fun optional() = apply { optional = true }
110112

@@ -130,11 +132,12 @@ class ParameterDescriptorWithType(val name: String) : IgnorableDescriptor<Parame
130132
var optional: Boolean = false
131133
private set
132134

133-
var default: Any? = null
135+
@JsonProperty("default")
136+
var defaultValue: Any? = null
134137

135138
fun type(type: SimpleType) = apply { this.type = type }
136139

137-
fun default(default: Any) = apply { this.default = default }
140+
fun defaultValue(defaultValue: Any) = apply { this.defaultValue = defaultValue }
138141

139142
fun optional() = apply { optional = true }
140143

‎restdocs-api-spec/src/test/kotlin/com/epages/restdocs/apispec/ResourceSnippetTest.kt‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -222,11 +222,11 @@ class ResourceSnippetTest {
222222
}
223223

224224
private fun givenRequestParameterDescriptors() {
225-
parametersBuilder.requestParameters(parameterWithName("test-param").type(SimpleType.STRING).default("default-value").description("test param"))
225+
parametersBuilder.requestParameters(parameterWithName("test-param").type(SimpleType.STRING).defaultValue("default-value").description("test param"))
226226
}
227227

228228
private fun givenRequestAndResponseHeaderDescriptors() {
229-
val headerDescriptor = ResourceDocumentation.headerWithName("X-SOME").type(SimpleType.STRING).default("default-value").description("some")
229+
val headerDescriptor = ResourceDocumentation.headerWithName("X-SOME").type(SimpleType.STRING).defaultValue("default-value").description("some")
230230
parametersBuilder.requestHeaders(headerDescriptor)
231231
parametersBuilder.responseHeaders(HeaderDocumentation.headerWithName("X-SOME").description("some"))
232232
}

0 commit comments

Comments
 (0)