Skip to content
This repository was archived by the owner on Dec 25, 2024. It is now read-only.

Commit 023e687

Browse files
committed
Sample regen so docs can show correct type for list builder and build method
1 parent 432bb47 commit 023e687

File tree

21 files changed

+106
-44
lines changed

21 files changed

+106
-44
lines changed

samples/client/3_0_3_unit_test/java/.openapi-generator/FILES

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -263,6 +263,7 @@ src/test/java/org/openapijsonschematools/client/configurations/JsonSchemaKeyword
263263
src/test/java/org/openapijsonschematools/client/schemas/AnyTypeSchemaTest.java
264264
src/test/java/org/openapijsonschematools/client/schemas/ArrayTypeSchemaTest.java
265265
src/test/java/org/openapijsonschematools/client/schemas/BooleanSchemaTest.java
266+
src/test/java/org/openapijsonschematools/client/schemas/ListBuilderTest.java
266267
src/test/java/org/openapijsonschematools/client/schemas/ListSchemaTest.java
267268
src/test/java/org/openapijsonschematools/client/schemas/MapSchemaTest.java
268269
src/test/java/org/openapijsonschematools/client/schemas/NullSchemaTest.java

samples/client/3_0_3_unit_test/java/docs/components/schemas/ArrayTypeMatchesArrays.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ ArrayTypeMatchesArrays.ArrayTypeMatchesArraysList validatedPayload =
5858
| @Nullable Object | validate(@Nullable Object arg, SchemaConfiguration configuration) |
5959
## ArrayTypeMatchesArraysListBuilder
6060
public class ArrayTypeMatchesArraysListBuilder<br>
61-
builder for `List<? extends @Nullable Object>`
61+
builder for `List<@Nullable Object>`
6262

6363
A class that builds the List input type
6464

@@ -80,7 +80,7 @@ A class that builds the List input type
8080
| ArrayTypeMatchesArraysListBuilder | add(double item) |
8181
| ArrayTypeMatchesArraysListBuilder | add(List<?> item) |
8282
| ArrayTypeMatchesArraysListBuilder | add(Map<String, ?> item) |
83-
| List<? extends @Nullable Object> | build()<br>Returns list input that should be used with Schema.validate |
83+
| List<@Nullable Object> | build()<br>Returns list input that should be used with Schema.validate |
8484

8585
## ArrayTypeMatchesArraysList
8686
public class ArrayTypeMatchesArraysList<br>

samples/client/3_0_3_unit_test/java/docs/components/schemas/RefInItems.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ RefInItems.RefInItemsList validatedPayload =
5757
| @Nullable Object | validate(@Nullable Object arg, SchemaConfiguration configuration) |
5858
## RefInItemsListBuilder
5959
public class RefInItemsListBuilder<br>
60-
builder for `List<? extends @Nullable Object>`
60+
builder for `List<@Nullable Object>`
6161

6262
A class that builds the List input type
6363

@@ -79,7 +79,7 @@ A class that builds the List input type
7979
| RefInItemsListBuilder | add(double item) |
8080
| RefInItemsListBuilder | add(List<?> item) |
8181
| RefInItemsListBuilder | add(Map<String, ?> item) |
82-
| List<? extends @Nullable Object> | build()<br>Returns list input that should be used with Schema.validate |
82+
| List<@Nullable Object> | build()<br>Returns list input that should be used with Schema.validate |
8383

8484
## RefInItemsList
8585
public class RefInItemsList<br>
Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
package org.openapijsonschematools.client.schemas;
2+
3+
import org.checkerframework.checker.nullness.qual.Nullable;
4+
import org.junit.Assert;
5+
import org.junit.Test;
6+
7+
import java.util.ArrayList;
8+
import java.util.List;
9+
10+
public class ListBuilderTest {
11+
public static class NullableListWithNullableItemsListBuilder {
12+
// class to build List<@Nullable List<Number>>
13+
private final List<@Nullable List<Number>> list;
14+
15+
public NullableListWithNullableItemsListBuilder() {
16+
list = new ArrayList<>();
17+
}
18+
19+
public NullableListWithNullableItemsListBuilder(List<@Nullable List<Number>> list) {
20+
this.list = list;
21+
}
22+
23+
public NullableListWithNullableItemsListBuilder add(Void item) {
24+
list.add(null);
25+
return this;
26+
}
27+
28+
public NullableListWithNullableItemsListBuilder add(List<Number> item) {
29+
list.add(item);
30+
return this;
31+
}
32+
33+
public List<@Nullable List<Number>> build() {
34+
return list;
35+
}
36+
}
37+
38+
@Test
39+
public void testSucceedsWithNullInput() {
40+
List<@Nullable List<Number>> inList = new ArrayList<>();
41+
inList.add(null);
42+
var builder = new NullableListWithNullableItemsListBuilder(inList);
43+
Assert.assertEquals(inList, builder.build());
44+
45+
builder = new NullableListWithNullableItemsListBuilder();
46+
builder.add((Void) null);
47+
Assert.assertEquals(inList, builder.build());
48+
}
49+
50+
@Test
51+
public void testSucceedsWithNonNullInput() {
52+
List<List<Number>> inList = new ArrayList<>();
53+
inList.add(List.of(1));
54+
var builder = new NullableListWithNullableItemsListBuilder(inList);
55+
Assert.assertEquals(inList, builder.build());
56+
57+
builder = new NullableListWithNullableItemsListBuilder();
58+
builder.add(List.of(1));
59+
Assert.assertEquals(inList, builder.build());
60+
}
61+
}

samples/client/petstore/java/docs/components/requestbodies/userarray/content/applicationjson/Schema.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ Schema.SchemaList validatedPayload =
9595
| @Nullable Object | validate(@Nullable Object arg, SchemaConfiguration configuration) |
9696
## SchemaListBuilder
9797
public class SchemaListBuilder<br>
98-
builder for `List<Map<String, ? extends @Nullable Object>>`
98+
builder for `List<Map<String, @Nullable Object>>`
9999

100100
A class that builds the List input type
101101

@@ -109,7 +109,7 @@ A class that builds the List input type
109109
| Modifier and Type | Method and Description |
110110
| ----------------- | ---------------------- |
111111
| SchemaListBuilder | add(Map<String, @Nullable Object> item) |
112-
| List<Map<String, ? extends @Nullable Object>> | build()<br>Returns list input that should be used with Schema.validate |
112+
| List<Map<String, @Nullable Object>> | build()<br>Returns list input that should be used with Schema.validate |
113113

114114
## SchemaList
115115
public class SchemaList<br>

samples/client/petstore/java/docs/components/responses/successfulxmlandjsonarrayofpet/content/applicationjson/Schema.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ Schema.SchemaList validatedPayload =
101101
| @Nullable Object | validate(@Nullable Object arg, SchemaConfiguration configuration) |
102102
## SchemaListBuilder
103103
public class SchemaListBuilder<br>
104-
builder for `List<Map<String, ? extends @Nullable Object>>`
104+
builder for `List<Map<String, @Nullable Object>>`
105105

106106
A class that builds the List input type
107107

@@ -115,7 +115,7 @@ A class that builds the List input type
115115
| Modifier and Type | Method and Description |
116116
| ----------------- | ---------------------- |
117117
| SchemaListBuilder | add(Map<String, @Nullable Object> item) |
118-
| List<Map<String, ? extends @Nullable Object>> | build()<br>Returns list input that should be used with Schema.validate |
118+
| List<Map<String, @Nullable Object>> | build()<br>Returns list input that should be used with Schema.validate |
119119

120120
## SchemaList
121121
public class SchemaList<br>

samples/client/petstore/java/docs/components/responses/successfulxmlandjsonarrayofpet/content/applicationxml/Schema.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ Schema.SchemaList validatedPayload =
101101
| @Nullable Object | validate(@Nullable Object arg, SchemaConfiguration configuration) |
102102
## SchemaListBuilder
103103
public class SchemaListBuilder<br>
104-
builder for `List<Map<String, ? extends @Nullable Object>>`
104+
builder for `List<Map<String, @Nullable Object>>`
105105

106106
A class that builds the List input type
107107

@@ -115,7 +115,7 @@ A class that builds the List input type
115115
| Modifier and Type | Method and Description |
116116
| ----------------- | ---------------------- |
117117
| SchemaListBuilder | add(Map<String, @Nullable Object> item) |
118-
| List<Map<String, ? extends @Nullable Object>> | build()<br>Returns list input that should be used with Schema.validate |
118+
| List<Map<String, @Nullable Object>> | build()<br>Returns list input that should be used with Schema.validate |
119119

120120
## SchemaList
121121
public class SchemaList<br>

samples/client/petstore/java/docs/components/schemas/AnimalFarm.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ AnimalFarm.AnimalFarmList validatedPayload =
6767
| @Nullable Object | validate(@Nullable Object arg, SchemaConfiguration configuration) |
6868
## AnimalFarmListBuilder
6969
public class AnimalFarmListBuilder<br>
70-
builder for `List<Map<String, ? extends @Nullable Object>>`
70+
builder for `List<Map<String, @Nullable Object>>`
7171

7272
A class that builds the List input type
7373

@@ -81,7 +81,7 @@ A class that builds the List input type
8181
| Modifier and Type | Method and Description |
8282
| ----------------- | ---------------------- |
8383
| AnimalFarmListBuilder | add(Map<String, @Nullable Object> item) |
84-
| List<Map<String, ? extends @Nullable Object>> | build()<br>Returns list input that should be used with Schema.validate |
84+
| List<Map<String, @Nullable Object>> | build()<br>Returns list input that should be used with Schema.validate |
8585

8686
## AnimalFarmList
8787
public class AnimalFarmList<br>

samples/client/petstore/java/docs/components/schemas/ArrayHoldingAnyType.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ ArrayHoldingAnyType.ArrayHoldingAnyTypeList validatedPayload =
5858
| @Nullable Object | validate(@Nullable Object arg, SchemaConfiguration configuration) |
5959
## ArrayHoldingAnyTypeListBuilder
6060
public class ArrayHoldingAnyTypeListBuilder<br>
61-
builder for `List<? extends @Nullable Object>`
61+
builder for `List<@Nullable Object>`
6262

6363
A class that builds the List input type
6464

@@ -80,7 +80,7 @@ A class that builds the List input type
8080
| ArrayHoldingAnyTypeListBuilder | add(double item) |
8181
| ArrayHoldingAnyTypeListBuilder | add(List<?> item) |
8282
| ArrayHoldingAnyTypeListBuilder | add(Map<String, ?> item) |
83-
| List<? extends @Nullable Object> | build()<br>Returns list input that should be used with Schema.validate |
83+
| List<@Nullable Object> | build()<br>Returns list input that should be used with Schema.validate |
8484

8585
## ArrayHoldingAnyTypeList
8686
public class ArrayHoldingAnyTypeList<br>

samples/client/petstore/java/docs/components/schemas/ArrayOfEnums.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ ArrayOfEnums.ArrayOfEnumsList validatedPayload =
5858
| @Nullable Object | validate(@Nullable Object arg, SchemaConfiguration configuration) |
5959
## ArrayOfEnumsListBuilder
6060
public class ArrayOfEnumsListBuilder<br>
61-
builder for `List<? extends @Nullable String>`
61+
builder for `List<@Nullable String>`
6262

6363
A class that builds the List input type
6464

@@ -75,7 +75,7 @@ A class that builds the List input type
7575
| ArrayOfEnumsListBuilder | add(String item) |
7676
| ArrayOfEnumsListBuilder | add([StringEnum.StringStringEnumEnums](../../components/schemas/StringEnum.md#stringstringenumenums) item) |
7777
| ArrayOfEnumsListBuilder | add([StringEnum.NullStringEnumEnums](../../components/schemas/StringEnum.md#nullstringenumenums) item) |
78-
| List<? extends @Nullable String> | build()<br>Returns list input that should be used with Schema.validate |
78+
| List<@Nullable String> | build()<br>Returns list input that should be used with Schema.validate |
7979

8080
## ArrayOfEnumsList
8181
public class ArrayOfEnumsList<br>

0 commit comments

Comments
 (0)