Skip to content

Commit 395f48a

Browse files
wilxwilx
committed
docs: clarify annotation vendor extension values
1 parent 8151edb commit 395f48a

29 files changed

Lines changed: 62 additions & 62 deletions

‎docs/generators/groovy.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -82,8 +82,8 @@ These options may be applied as additional-properties (cli) or configOptions (pl
8282
|x-tags|Specify multiple swagger tags for operation|OPERATION|null
8383
|x-accepts|Specify custom value for 'Accept' header for operation|OPERATION|null
8484
|x-content-type|Specify custom value for 'Content-Type' header for operation|OPERATION|null
85-
|x-class-extra-annotation|List of custom annotations to be added to model|MODEL|null
86-
|x-field-extra-annotation|List of custom annotations to be added to property|FIELD, OPERATION_PARAMETER|null
85+
|x-class-extra-annotation|Custom annotation(s) to be added to model; accepts a string or list of strings|MODEL|null
86+
|x-field-extra-annotation|Custom annotation(s) to be added to property; accepts a string or list of strings|FIELD, OPERATION_PARAMETER|null
8787

8888

8989
## IMPORT MAPPING

‎docs/generators/java-camel.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -141,9 +141,9 @@ These options may be applied as additional-properties (cli) or configOptions (pl
141141
|x-tags|Specify multiple swagger tags for operation|OPERATION|null
142142
|x-accepts|Specify custom value for 'Accept' header for operation|OPERATION|null
143143
|x-content-type|Specify custom value for 'Content-Type' header for operation|OPERATION|null
144-
|x-class-extra-annotation|List of custom annotations to be added to model|MODEL|null
145-
|x-field-extra-annotation|List of custom annotations to be added to property|FIELD, OPERATION_PARAMETER|null
146-
|x-operation-extra-annotation|List of custom annotations to be added to operation|OPERATION|null
144+
|x-class-extra-annotation|Custom annotation(s) to be added to model; accepts a string or list of strings|MODEL|null
145+
|x-field-extra-annotation|Custom annotation(s) to be added to property; accepts a string or list of strings|FIELD, OPERATION_PARAMETER|null
146+
|x-operation-extra-annotation|Custom annotation(s) to be added to operation; accepts a string or list of strings|OPERATION|null
147147
|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
148148
|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
149149
|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

‎docs/generators/java-dubbo.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -95,8 +95,8 @@ These options may be applied as additional-properties (cli) or configOptions (pl
9595
|x-tags|Specify multiple swagger tags for operation|OPERATION|null
9696
|x-accepts|Specify custom value for 'Accept' header for operation|OPERATION|null
9797
|x-content-type|Specify custom value for 'Content-Type' header for operation|OPERATION|null
98-
|x-class-extra-annotation|List of custom annotations to be added to model|MODEL|null
99-
|x-field-extra-annotation|List of custom annotations to be added to property|FIELD, OPERATION_PARAMETER|null
98+
|x-class-extra-annotation|Custom annotation(s) to be added to model; accepts a string or list of strings|MODEL|null
99+
|x-field-extra-annotation|Custom annotation(s) to be added to property; accepts a string or list of strings|FIELD, OPERATION_PARAMETER|null
100100

101101

102102
## IMPORT MAPPING

‎docs/generators/java-helidon-client.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -81,8 +81,8 @@ These options may be applied as additional-properties (cli) or configOptions (pl
8181
|x-tags|Specify multiple swagger tags for operation|OPERATION|null
8282
|x-accepts|Specify custom value for 'Accept' header for operation|OPERATION|null
8383
|x-content-type|Specify custom value for 'Content-Type' header for operation|OPERATION|null
84-
|x-class-extra-annotation|List of custom annotations to be added to model|MODEL|null
85-
|x-field-extra-annotation|List of custom annotations to be added to property|FIELD, OPERATION_PARAMETER|null
84+
|x-class-extra-annotation|Custom annotation(s) to be added to model; accepts a string or list of strings|MODEL|null
85+
|x-field-extra-annotation|Custom annotation(s) to be added to property; accepts a string or list of strings|FIELD, OPERATION_PARAMETER|null
8686
|x-webclient-blocking|Specifies if method for specific operation should be blocking or non-blocking(ex: return `Mono<T>/Flux<T>` or `return T/List<T>/Set<T>` & execute `.block()` inside generated method)|OPERATION|false
8787

8888

‎docs/generators/java-helidon-server.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -84,8 +84,8 @@ These options may be applied as additional-properties (cli) or configOptions (pl
8484
|x-tags|Specify multiple swagger tags for operation|OPERATION|null
8585
|x-accepts|Specify custom value for 'Accept' header for operation|OPERATION|null
8686
|x-content-type|Specify custom value for 'Content-Type' header for operation|OPERATION|null
87-
|x-class-extra-annotation|List of custom annotations to be added to model|MODEL|null
88-
|x-field-extra-annotation|List of custom annotations to be added to property|FIELD, OPERATION_PARAMETER|null
87+
|x-class-extra-annotation|Custom annotation(s) to be added to model; accepts a string or list of strings|MODEL|null
88+
|x-field-extra-annotation|Custom annotation(s) to be added to property; accepts a string or list of strings|FIELD, OPERATION_PARAMETER|null
8989

9090

9191
## IMPORT MAPPING

‎docs/generators/java-inflector.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -84,8 +84,8 @@ These options may be applied as additional-properties (cli) or configOptions (pl
8484
|x-tags|Specify multiple swagger tags for operation|OPERATION|null
8585
|x-accepts|Specify custom value for 'Accept' header for operation|OPERATION|null
8686
|x-content-type|Specify custom value for 'Content-Type' header for operation|OPERATION|null
87-
|x-class-extra-annotation|List of custom annotations to be added to model|MODEL|null
88-
|x-field-extra-annotation|List of custom annotations to be added to property|FIELD, OPERATION_PARAMETER|null
87+
|x-class-extra-annotation|Custom annotation(s) to be added to model; accepts a string or list of strings|MODEL|null
88+
|x-field-extra-annotation|Custom annotation(s) to be added to property; accepts a string or list of strings|FIELD, OPERATION_PARAMETER|null
8989

9090

9191
## IMPORT MAPPING

‎docs/generators/java-micronaut-client.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -105,8 +105,8 @@ These options may be applied as additional-properties (cli) or configOptions (pl
105105
|x-tags|Specify multiple swagger tags for operation|OPERATION|null
106106
|x-accepts|Specify custom value for 'Accept' header for operation|OPERATION|null
107107
|x-content-type|Specify custom value for 'Content-Type' header for operation|OPERATION|null
108-
|x-class-extra-annotation|List of custom annotations to be added to model|MODEL|null
109-
|x-field-extra-annotation|List of custom annotations to be added to property|FIELD, OPERATION_PARAMETER|null
108+
|x-class-extra-annotation|Custom annotation(s) to be added to model; accepts a string or list of strings|MODEL|null
109+
|x-field-extra-annotation|Custom annotation(s) to be added to property; accepts a string or list of strings|FIELD, OPERATION_PARAMETER|null
110110

111111

112112
## IMPORT MAPPING

‎docs/generators/java-micronaut-server.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -104,8 +104,8 @@ These options may be applied as additional-properties (cli) or configOptions (pl
104104
|x-tags|Specify multiple swagger tags for operation|OPERATION|null
105105
|x-accepts|Specify custom value for 'Accept' header for operation|OPERATION|null
106106
|x-content-type|Specify custom value for 'Content-Type' header for operation|OPERATION|null
107-
|x-class-extra-annotation|List of custom annotations to be added to model|MODEL|null
108-
|x-field-extra-annotation|List of custom annotations to be added to property|FIELD, OPERATION_PARAMETER|null
107+
|x-class-extra-annotation|Custom annotation(s) to be added to model; accepts a string or list of strings|MODEL|null
108+
|x-field-extra-annotation|Custom annotation(s) to be added to property; accepts a string or list of strings|FIELD, OPERATION_PARAMETER|null
109109

110110

111111
## IMPORT MAPPING

‎docs/generators/java-microprofile.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -126,8 +126,8 @@ These options may be applied as additional-properties (cli) or configOptions (pl
126126
|x-tags|Specify multiple swagger tags for operation|OPERATION|null
127127
|x-accepts|Specify custom value for 'Accept' header for operation|OPERATION|null
128128
|x-content-type|Specify custom value for 'Content-Type' header for operation|OPERATION|null
129-
|x-class-extra-annotation|List of custom annotations to be added to model|MODEL|null
130-
|x-field-extra-annotation|List of custom annotations to be added to property|FIELD, OPERATION_PARAMETER|null
129+
|x-class-extra-annotation|Custom annotation(s) to be added to model; accepts a string or list of strings|MODEL|null
130+
|x-field-extra-annotation|Custom annotation(s) to be added to property; accepts a string or list of strings|FIELD, OPERATION_PARAMETER|null
131131
|x-webclient-blocking|Specifies if method for specific operation should be blocking or non-blocking(ex: return `Mono<T>/Flux<T>` or `return T/List<T>/Set<T>` & execute `.block()` inside generated method)|OPERATION|false
132132

133133

‎docs/generators/java-msf4j.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -90,8 +90,8 @@ These options may be applied as additional-properties (cli) or configOptions (pl
9090
|x-tags|Specify multiple swagger tags for operation|OPERATION|null
9191
|x-accepts|Specify custom value for 'Accept' header for operation|OPERATION|null
9292
|x-content-type|Specify custom value for 'Content-Type' header for operation|OPERATION|null
93-
|x-class-extra-annotation|List of custom annotations to be added to model|MODEL|null
94-
|x-field-extra-annotation|List of custom annotations to be added to property|FIELD, OPERATION_PARAMETER|null
93+
|x-class-extra-annotation|Custom annotation(s) to be added to model; accepts a string or list of strings|MODEL|null
94+
|x-field-extra-annotation|Custom annotation(s) to be added to property; accepts a string or list of strings|FIELD, OPERATION_PARAMETER|null
9595

9696

9797
## IMPORT MAPPING

0 commit comments

Comments
 (0)