cleanup

Author: hauner

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

@@ -61,7 +61,7 @@ The following table shows the automatic mapping of OpenAPIs primitive types to J
 
 | `string`
 | `date-time`
-| `java.time.OffsetDataTime`
+| `java.time.OffsetDataTime` (better would be `java.time.Instant`)
 
 | `string`
 | `password`

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

@@ -32,14 +32,14 @@ map:
       parameters:
         - name: {parameter name}  =>  {target type}
 
-        # the list of parameter mappings can include additional parameters
+        # add a (usually technical) parameter that is not described in the OpenAPI
         - add: {parameter name}  =>  {target type}
 
       # list of path specific content mappings, mapped by content type
       responses:
         - content: {content type}  =>  {target type}
 
-    # a path
+    # another path
     /foobar:
       # excluding an endpoint
       exclude: true
@@ -61,7 +61,7 @@ map:
       parameters:
         - name: {parameter name}  =>  {target type}
 
-        # the list of parameter mappings can include additional parameters
+        # add a (usually technical) parameter that is not described in the OpenAPI
         - add: {parameter name}  =>  {target type}
 
       # list of path specific content mappings, mapped by content type

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

@@ -1,10 +1,18 @@
 = (global) Parameter mappings
 
-Global parameter mapping will replace any usage of an OpenAPI type in the api description based on
- the parameters **name** to the given java type.
+Parameter mappings, as the name suggests, apply to the parameters of an endpoint method.
 
-It is defined like below, and it should be added to the `map/parameters` section in the mapping.yaml
-which is a list of global parameter mappings.
+== parameter mapping by name
+
+A global parameter mapping will replace any usage of an OpenAPI type in the api description based on the parameters **name** to the given java type.
+
+[CAUTION]
+====
+Since the processor will simply match the parameter by its name, take care that all parameters of
+that name should really use the same type!
+====
+
+It is defined like below, and it should be added to the `map/parameters` section in the mapping.yaml which is a list of global parameter mappings.
 
 A single global parameter mapping can have the following properties:
 
@@ -28,12 +36,6 @@ endpoint content types **{parameter name}**.
 java type given by **{target type}**.
 
 
-[CAUTION]
-====
-Since the processor will simply match the parameters by their name take care that all parameters of
-that name should really use the same type!
-====
-
 == Example
 
 Given the following (global) parameter mapping

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

@@ -58,11 +58,11 @@ map:
   types:
     - type: {source type}  =>  {target type}
 
-  # list of global parameter mappings, mapped by parameter name
+  # list of global parameter mappings
   parameters:
     - name: {parameter name}  =>  {target type}
 
-    # the list of parameter mappings can include additional parameters
+    # add a (usually technical) parameter that is not described in the OpenAPI
     - add: {parameter name}  =>  {target type}
 
   # list of global content mappings, mapped by content type
@@ -93,11 +93,11 @@ map:
       types:
         - from: {source type}  =>  {target type}
 
-      # list of path specific parameter mappings, mapped by parameter name
+      # list of path specific parameter mappings
       parameters:
         - name: {parameter name}  =>  {target type}
 
-        # the list of parameter mappings can include additional parameters
+        # add a (usually technical) parameter that is not described in the OpenAPI
         - add: {parameter name}  =>  {target type}
 
       # list of path specific content mappings, mapped by content type