Skip to content

Commit f05c69f

Browse files
committed
clean up docs
1 parent ee85ba8 commit f05c69f

26 files changed

+93
-69
lines changed

docs/modules/ROOT/pages/gradle.adoc

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
1-
= Gradle Plugin
21
include::partial$links.adoc[]
32

4-
The xref:gradle::index.adoc[openapi-processor-gradle] gradle plugin can run any of the **openapi-processor**'s.
3+
= Gradle Plugin
4+
5+
The xref:gradle::index.adoc[openapi-processor-gradle] Gradle plugin can run any of the **openapi-processor**'s.
56

6-
To use it in a Gradle project, the Gradle file of the project requires a few additional instructions. The following sections describe how to activate & configure **openapi-processor-spring** in a `build.gradle` file.
7+
To use it in a Gradle project, the Gradle file of the project requires a few additional instructions. The following sections describe how to activate and configure **openapi-processor-spring** in a `build.gradle` file.
78

89

910
== adding the plugin
1011

11-
To activate the plugin add it to (like any other gradle plugin) the `plugins` configuration:
12+
To activate the plugin, add it to (like any other Gradle plugin) the `plugins` configuration:
1213

1314
[source,groovy]
1415
----
@@ -21,7 +22,7 @@ plugins {
2122

2223
== configuring processor-spring
2324

24-
The plugin will add an `openapiProcessor` configuration block that is used to configure the processors. Configuration for a specific processor belongs inside it with the processor name as configuration block name.
25+
The plugin will add an `openapiProcessor` configuration block used to configure the processors. Configuration for a specific processor belongs inside it with the processor name as configuration block name.
2526

2627
[source,groovy]
2728
----

docs/modules/ROOT/pages/links.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
1-
= Links
21
include::partial$links.adoc[]
32

3+
= Links
4+
45
== OpenAPI
56

67
* link:{openapi}[OpenAPI, window="_blank"] Homepage of the OpenAPI Initiative.

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ Previously an annotation mapping was lost if the type was mapped at the same tim
101101

102102
Assume the following mapping:
103103

104-
[source,yaml,subs="attributes"]
104+
[source,yaml,subs="attributes+"]
105105
----
106106
openapi-processor-mapping: {var-mapping-version}
107107
@@ -147,7 +147,7 @@ public class FooBar {
147147

148148
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`.
149149

150-
[source,yaml,subs="attributes"]
150+
[source,yaml,subs=attributes+]
151151
----
152152
openapi: {var-openapi-version}
153153
info:
@@ -218,7 +218,7 @@ components:
218218

219219
and a `mapping.yaml` with annotation type mappings:
220220

221-
[source,yaml,subs="attributes"]
221+
[source,yaml,subs=attributes+]
222222
----
223223
openapi-processor-mapping: {var-mapping-version} # <1>
224224

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ It is possible to add mappings that apply only to a specific http method. The mo
8383

8484
Here are a few examples of possible http endpoint mappings:
8585

86-
[source,yaml,subs="attributes"]
86+
[source,yaml,subs=attributes+]
8787
----
8888
openapi-processor-mapping: {var-mapping-version}
8989

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Apart from the annotation mapping by an OpenAPI type, openapi-processor can use
1010

1111
Here is a simple schema that has `x-` tensions on the `bar` property.
1212

13-
[source,yaml,subs="attributes"]
13+
[source,yaml,subs=attributes+]
1414
----
1515
openapi: {var-openapi-version}
1616
# ...
@@ -29,7 +29,7 @@ components:
2929

3030
In general openapi-processor will ignore the `x-` tension properties unless we map the `x-` tensions/values to annotations like this:
3131

32-
[source,yaml,subs="attributes"]
32+
[source,yaml,subs=attributes+]
3333
----
3434
openapi-processor-mapping: {var-mapping-version}
3535
options:

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Global type mapping will replace **any** usage of an OpenAPI type in the api des
55

66
It is defined like below, and it should be added to the `map/types` section in the `mapping.yaml` which is a list of global type mappings:
77

8-
[source,yaml,subs="attributes"]
8+
[source,yaml,subs=attributes+]
99
----
1010
openapi-processor-mapping: {var-mapping-version}
1111
@@ -134,7 +134,7 @@ This will generate the same code as the longer mapping version above.
134134

135135
It is possible to create type mappings with nested generics types. Here are a few examples:
136136

137-
[source,yaml,subs="attributes"]
137+
[source,yaml,subs=attributes+]
138138
----
139139
openapi-processor-mapping: {var-mapping-version}
140140

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ In case the processor uses the mapping, but it still doesn't behave as expected,
1111

1212
To control the logging, there are two new xref:processor/configuration.adoc#_logging[logging options].
1313

14-
[source,yaml,subs="attributes"]
14+
[source,yaml,subs=attributes+]
1515
----
1616
openapi-processor-mapping: {var-mapping-version}
1717
options:
@@ -100,7 +100,7 @@ If the `mapping-target` is `stdout` the processor output will be written without
100100

101101
to enable logging with maven use:
102102

103-
[source,yaml,subs="attributes"]
103+
[source,yaml,subs=attributes+]
104104
----
105105
openapi-processor-mapping: {var-mapping-version}
106106
options:
@@ -116,7 +116,7 @@ logging:
116116

117117
to get the simple output, or
118118

119-
[source,yaml,subs="attributes"]
119+
[source,yaml,subs=attributes+]
120120
----
121121
openapi-processor-mapping: {var-mapping-version}
122122
options:
@@ -139,7 +139,7 @@ Gradle requires the `mapping-target` to be `stdout`. Gradle can only globally en
139139

140140
to enable logging with gradle use:
141141

142-
[source,yaml,subs="attributes"]
142+
[source,yaml,subs=attributes+]
143143
----
144144
openapi-processor-mapping: {var-mapping-version}
145145
options:

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Normally the processor would generate a simple pojo with a `String` property.
3131

3232
By adding a `null` mapping for the `/foo` endpoint (this does work only on the endpoint level. A global null mapping gets ignored):
3333

34-
[source,yaml,subs="attributes"]
34+
[source,yaml,subs=attributes+]
3535
----
3636
openapi-processor-mapping: {var-mapping-version}
3737
Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,16 @@
1+
include::partial$vars.adoc[]
2+
13
= package-name mapping
24

35
The type mapping (v2 and up) configuration allows to reference the target `package-name` in generic parameters using the `+{package-name}+` expression. This makes it possible to adjust the `package-name` without touching the mapping, and it does reduce duplication.
46

5-
[source,yaml,subs="attributes"]
7+
[source,yaml,subs=attributes+]
68
----
79
openapi-processor-mapping: {var-mapping-version}
810
options:
911
package-name: io.openapiprocessor.generated
1012
1113
map:
1214
types:
13-
- type: FooPage => org.springframework.data.domain.Page<{package-name}.model.Foo>
15+
- type: FooPage => org.springframework.data.domain.Page<\{package-name}.model.Foo>
1416
----

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ map:
4848

4949
and an openapi.yaml with multiple endpoints having a parameter named "date"
5050

51-
[source,yaml,subs="attributes"]
51+
[source,yaml,subs=attributes+]
5252
----
5353
openapi: {var-openapi-version}
5454
info:
@@ -103,7 +103,7 @@ It is possible to add additional parameters that are not described in the OpenAP
103103

104104
While it is possible to add it at the global level, it is best used at the endpoint level.
105105

106-
[source,yaml,subs="attributes"]
106+
[source,yaml,subs=attributes+]
107107
----
108108
openapi-processor-mapping: {var-mapping-version}
109109
@@ -119,7 +119,7 @@ map:
119119

120120
Given the mapping configuration above and the following endpoint description:
121121

122-
[source,yaml,subs="attributes"]
122+
[source,yaml,subs=attributes+]
123123
----
124124
openapi: {var-openapi-version}
125125
info:
@@ -170,7 +170,7 @@ It may also be useful to remove a parameter, maybe it is handled by a request fi
170170

171171
Again, even if it is possible to add it at the global level, it is best used at the endpoint level.
172172

173-
[source,yaml,subs="attributes"]
173+
[source,yaml,subs=attributes+]
174174
----
175175
openapi-processor-mapping: {var-mapping-version}
176176
@@ -186,7 +186,7 @@ map:
186186

187187
Given the configuration above and the following endpoint description:
188188

189-
[source,yaml,subs="attributes"]
189+
[source,yaml,subs=attributes+]
190190
----
191191
openapi: {var-openapi-version}
192192
info:

0 commit comments

Comments
 (0)