Skip to content

Commit e292bfb

Browse files
committed
updated samples and docs as required by PR checklist
1 parent 65703ff commit e292bfb

File tree

480 files changed

+1924
-2316
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

480 files changed

+1924
-2316
lines changed

docs/generators/java-camel.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -133,9 +133,6 @@ These options may be applied as additional-properties (cli) or configOptions (pl
133133
|x-spring-paginated|Add `org.springframework.data.domain.Pageable` to controller method. Can be used to handle `page`, `size` and `sort` query parameters. If these query parameters are also specified in the operation spec, they will be removed from the controller method as their values can be obtained from the `Pageable` object.|OPERATION|false
134134
|x-version-param|Marker property that tells that this parameter would be used for endpoint versioning. Applicable for headers & query params. true/false|OPERATION_PARAMETER|null
135135
|x-pattern-message|Add this property whenever you need to customize the invalidation error message for the regex pattern of a variable|FIELD, OPERATION_PARAMETER|null
136-
|x-size-message|Add this property whenever you need to customize the invalidation error message for the size or length of a variable|FIELD, OPERATION_PARAMETER|null
137-
|x-minimum-message|Add this property whenever you need to customize the invalidation error message for the minimum value of a variable|FIELD, OPERATION_PARAMETER|null
138-
|x-maximum-message|Add this property whenever you need to customize the invalidation error message for the maximum value of a variable|FIELD, OPERATION_PARAMETER|null
139136
|x-spring-api-version|Value for 'version' attribute in @RequestMapping (for Spring 7 and above).|OPERATION|null
140137

141138

docs/generators/kotlin-spring.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -67,9 +67,6 @@ These options may be applied as additional-properties (cli) or configOptions (pl
6767
|x-discriminator-value|Used with model inheritance to specify value for discriminator that identifies current model|MODEL|
6868
|x-field-extra-annotation|List of custom annotations to be added to property|FIELD, OPERATION_PARAMETER|null
6969
|x-pattern-message|Add this property whenever you need to customize the invalidation error message for the regex pattern of a variable|FIELD, OPERATION_PARAMETER|null
70-
|x-size-message|Add this property whenever you need to customize the invalidation error message for the size or length of a variable|FIELD, OPERATION_PARAMETER|null
71-
|x-minimum-message|Add this property whenever you need to customize the invalidation error message for the minimum value of a variable|FIELD, OPERATION_PARAMETER|null
72-
|x-maximum-message|Add this property whenever you need to customize the invalidation error message for the maximum value of a variable|FIELD, OPERATION_PARAMETER|null
7370
|x-kotlin-implements|Ability to specify interfaces that model must implement|MODEL|empty array
7471
|x-kotlin-implements-fields|Specify attributes that are implemented by the interface(s) added via `x-kotlin-implements`|MODEL|empty array
7572

docs/generators/spring.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -126,9 +126,6 @@ These options may be applied as additional-properties (cli) or configOptions (pl
126126
|x-spring-paginated|Add `org.springframework.data.domain.Pageable` to controller method. Can be used to handle `page`, `size` and `sort` query parameters. If these query parameters are also specified in the operation spec, they will be removed from the controller method as their values can be obtained from the `Pageable` object.|OPERATION|false
127127
|x-version-param|Marker property that tells that this parameter would be used for endpoint versioning. Applicable for headers & query params. true/false|OPERATION_PARAMETER|null
128128
|x-pattern-message|Add this property whenever you need to customize the invalidation error message for the regex pattern of a variable|FIELD, OPERATION_PARAMETER|null
129-
|x-size-message|Add this property whenever you need to customize the invalidation error message for the size or length of a variable|FIELD, OPERATION_PARAMETER|null
130-
|x-minimum-message|Add this property whenever you need to customize the invalidation error message for the minimum value of a variable|FIELD, OPERATION_PARAMETER|null
131-
|x-maximum-message|Add this property whenever you need to customize the invalidation error message for the maximum value of a variable|FIELD, OPERATION_PARAMETER|null
132129
|x-spring-api-version|Value for 'version' attribute in @RequestMapping (for Spring 7 and above).|OPERATION|null
133130

134131

docs/generators/typescript-axios.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,6 @@ These options may be applied as additional-properties (cli) or configOptions (pl
4444
|supportsES6|Generate code that conforms to ES6.| |false|
4545
|useSingleRequestParameter|Setting this property to true will generate functions with a single argument containing all API endpoint parameters instead of one argument per parameter.| |false|
4646
|useSquareBracketsInArrayNames|Setting this property to true will add brackets to array attribute names, e.g. my_values[].| |false|
47-
|withAWSV4Signature|whether to include AWS v4 signature support| |false|
4847
|withInterfaces|Setting this property to true will generate interfaces next to the default class implementations.| |false|
4948
|withNodeImports|Setting this property to true adds imports for NodeJS| |false|
5049
|withSeparateModelsAndApi|Put the model and api in separate folders and in separate classes. This requires in addition a value for 'apiPackage' and 'modelPackage'| |false|
@@ -292,7 +291,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
292291
|OAuth2_ClientCredentials|✗|OAS2,OAS3
293292
|OAuth2_AuthorizationCode|✗|OAS2,OAS3
294293
|SignatureAuth|✗|OAS3
295-
|AWSV4Signature||ToolingExtension
294+
|AWSV4Signature||ToolingExtension
296295

297296
### Wire Format Feature
298297
| Name | Supported | Defined By |

samples/client/others/java/webclient-sealedInterface/api/openapi.yaml

Lines changed: 43 additions & 79 deletions
Original file line numberDiff line numberDiff line change
@@ -129,20 +129,17 @@ components:
129129
allOf:
130130
- $ref: "#/components/schemas/Addressable"
131131
- $ref: "#/components/schemas/Extensible"
132-
- description: Entity reference schema to be use for all entityRef class.
133-
properties:
134-
name:
135-
description: Name of the related entity.
136-
type: string
137-
'@referredType':
138-
description: The actual type of the target instance when needed for disambiguation.
139-
type: string
140-
type: object
141-
example: null
132+
description: Entity reference schema to be use for all entityRef class.
142133
discriminator:
143134
propertyName: '@type'
135+
properties:
136+
name:
137+
description: Name of the related entity.
138+
type: string
139+
'@referredType':
140+
description: The actual type of the target instance when needed for disambiguation.
141+
type: string
144142
type: object
145-
example: null
146143
FooRefOrValue:
147144
discriminator:
148145
propertyName: '@type'
@@ -154,82 +151,58 @@ components:
154151
Foo:
155152
allOf:
156153
- $ref: "#/components/schemas/Entity"
157-
- properties:
158-
fooPropA:
159-
type: string
160-
fooPropB:
161-
type: string
162-
type: object
163-
example: null
164154
example:
165-
'@baseType': '@baseType'
166-
'@type': '@type'
167155
fooPropA: fooPropA
168-
href: href
169-
id: id
170156
fooPropB: fooPropB
171-
'@schemaLocation': '@schemaLocation'
157+
properties:
158+
fooPropA:
159+
type: string
160+
fooPropB:
161+
type: string
172162
type: object
173163
FooRef:
174164
allOf:
175165
- $ref: "#/components/schemas/EntityRef"
176-
- properties:
177-
foorefPropA:
178-
type: string
179-
type: object
180-
example: null
166+
properties:
167+
foorefPropA:
168+
type: string
181169
type: object
182-
example: null
183170
BarRef:
184171
allOf:
185172
- $ref: "#/components/schemas/EntityRef"
186173
type: object
187174
Bar_Create:
188175
allOf:
189176
- $ref: "#/components/schemas/Entity"
190-
- properties:
191-
barPropA:
192-
type: string
193-
fooPropB:
194-
type: string
195-
foo:
196-
$ref: "#/components/schemas/FooRefOrValue"
197-
type: object
198-
example: null
177+
properties:
178+
barPropA:
179+
type: string
180+
fooPropB:
181+
type: string
182+
foo:
183+
$ref: "#/components/schemas/FooRefOrValue"
199184
type: object
200-
example: null
201185
Bar:
202186
allOf:
203187
- $ref: "#/components/schemas/Entity"
204-
- properties:
205-
id:
206-
type: string
207-
barPropA:
208-
type: string
209-
fooPropB:
210-
type: string
211-
foo:
212-
$ref: "#/components/schemas/FooRefOrValue"
213-
required:
214-
- id
215-
type: object
216-
example: null
217188
example:
218-
'@baseType': '@baseType'
219-
'@type': '@type'
220189
foo:
221-
'@baseType': '@baseType'
222-
'@type': '@type'
223190
fooPropA: fooPropA
224-
href: href
225-
id: id
226191
fooPropB: fooPropB
227-
'@schemaLocation': '@schemaLocation'
228-
href: href
229192
id: id
230193
fooPropB: fooPropB
231-
'@schemaLocation': '@schemaLocation'
232194
barPropA: barPropA
195+
properties:
196+
id:
197+
type: string
198+
barPropA:
199+
type: string
200+
fooPropB:
201+
type: string
202+
foo:
203+
$ref: "#/components/schemas/FooRefOrValue"
204+
required:
205+
- id
233206
type: object
234207
BarRefOrValue:
235208
oneOf:
@@ -240,33 +213,24 @@ components:
240213
Pizza:
241214
allOf:
242215
- $ref: "#/components/schemas/Entity"
243-
- properties:
244-
pizzaSize:
245-
type: number
246-
type: object
247-
example: null
216+
properties:
217+
pizzaSize:
218+
type: number
248219
type: object
249-
example: null
250220
Pasta:
251221
allOf:
252222
- $ref: "#/components/schemas/Entity"
253-
- properties:
254-
vendor:
255-
type: string
256-
type: object
257-
example: null
223+
properties:
224+
vendor:
225+
type: string
258226
type: object
259-
example: null
260227
PizzaSpeziale:
261228
allOf:
262229
- $ref: "#/components/schemas/Pizza"
263-
- properties:
264-
toppings:
265-
type: string
266-
type: object
267-
example: null
230+
properties:
231+
toppings:
232+
type: string
268233
type: object
269-
example: null
270234
FruitType:
271235
enum:
272236
- APPLE

samples/client/others/java/webclient-sealedInterface/docs/EntityRef.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,19 @@
22

33
# EntityRef
44

5+
Entity reference schema to be use for all entityRef class.
56

67
## Properties
78

89
| Name | Type | Description | Notes |
910
|------------ | ------------- | ------------- | -------------|
11+
|**name** | **String** | Name of the related entity. | [optional] |
12+
|**atReferredType** | **String** | The actual type of the target instance when needed for disambiguation. | [optional] |
1013
|**href** | **String** | Hyperlink reference | [optional] |
1114
|**id** | **String** | unique identifier | [optional] |
1215
|**atSchemaLocation** | **String** | A URI to a JSON-Schema file that defines additional attributes and relationships | [optional] |
1316
|**atBaseType** | **String** | When sub-classing, this defines the super-class | [optional] |
1417
|**atType** | **String** | When sub-classing, this defines the sub-class Extensible name | |
15-
|**name** | **String** | Name of the related entity. | [optional] |
16-
|**atReferredType** | **String** | The actual type of the target instance when needed for disambiguation. | [optional] |
1718

1819

1920

0 commit comments

Comments
 (0)