Skip to content

Commit 91131ce

Browse files
committed
improve documentation
1 parent 16d02d7 commit 91131ce

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

docs/modules/ROOT/pages/mapping/annotation.adoc

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,12 @@
22
include::partial$links.adoc[]
33
include::partial$vars.adoc[]
44

5-
It is possible to add additional annotations to a `source type`. Currently, this is available as
5+
It is possible to add additional annotations to the generated `target type`. Currently, this is available as
66

77
* global _annotation type mapping_:
88
+
9-
it adds an annotation to the *model class* generated for the `source type`.
9+
it adds an annotation to the *model class* generated for the `source type`. +
10+
+
1011
1112
* global & endpoint parameter _annotation mapping_:
1213
+
@@ -27,7 +28,7 @@ type: {source type} @ {annotation type}
2728
2829
** **{source type}** is the type name used in the OpenAPI description and names the type that should receive the additional annotation. This can be a **+{type}:{format}+** combination like `string:uuid`.
2930

30-
** **{annotation type}** is the fully qualified class name of the java annotation type.It may have parameters (see example below).
31+
** **{annotation type}** is the fully qualified class name of the java annotation type. It may have parameters (see example below).
3132

3233
or with parameter name:
3334

@@ -42,7 +43,7 @@ name: {parameter name} @ {annotation type}
4243
4344
** **{parameter name}** is the name of the parameter in the generated interface that should receive the additional annotation.
4445

45-
** **{annotation type}** is the fully qualified class name of the java annotation type.It may have parameters (see example below).
46+
** **{annotation type}** is the fully qualified class name of the java annotation type. It may have parameters (see example below).
4647

4748

4849
Here is a list of examples using different parameters:
@@ -145,7 +146,7 @@ public class FooBar {
145146

146147
== mapping example
147148

148-
Given the following OpenAPI description, that describe two (echo like) endpoints that receive an object via post and return the same object. In the mapping file we add a custom bean validation annotation. It checks the sum of both properties in `Foo` and `Bar`.
149+
Given the following OpenAPI description, that describes two echo-(like) endpoints that receive an object via post and return the same object. In the mapping file we add a custom bean validation annotation. It checks the sum of both properties in `Foo` and `Bar`.
149150

150151
[source,yaml,subs=attributes+]
151152
----

0 commit comments

Comments
 (0)