Skip to content

Commit 9428492

Browse files
committed
updated documentation (#439)
1 parent f5538e6 commit 9428492

1 file changed

Lines changed: 25 additions & 9 deletions

File tree

docs/modules/ROOT/pages/processor/configuration.adoc

Lines changed: 25 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
= Configuration
22
:toc:
3+
:toclevels: 4
34
include::partial$links.adoc[]
45
include::partial$vars.adoc[]
56

@@ -66,7 +67,7 @@ Interfaces and models will be generated into the `api` and `model` subpackages o
6667
* the final package name of the generated interfaces will be `"$\{package-name\}.api"`,
6768
* and the final package name of the generated models will be `"$\{package-name\}.model"`
6869

69-
==== example
70+
*example*
7071

7172
[source,yaml,subs=attributes+]
7273
----
@@ -127,7 +128,7 @@ Usually you will separate the classes by putting them in different packages. Thi
127128

128129
If a schema name from the OpenAPI description already ends with the `model-name-suffix`, the processor will **not** append the suffix. This allows migrating an existing api with a suffix in the API to `model-name-suffix` step by step.
129130

130-
==== example
131+
*example*
131132

132133
*OpenAPI*
133134
[source,yaml]
@@ -209,7 +210,7 @@ public class BarResource { // <2>
209210

210211
generate pojos (class with get/set property methods) or records model classes from OpenAPI schemas. This is a global setting in the `mapping.yaml`. It can either have the value `default` (which is default) to generate pojos or `record` to generate records.
211212

212-
==== example
213+
*example*
213214

214215
*mapping.yaml*
215216
[source,yaml,subs=attributes+]
@@ -264,7 +265,7 @@ public class Foo {
264265
}
265266
----
266267

267-
=== model-accessors ([.badge .badge-since]+new with 2025.1+)
268+
=== model-accessors
268269

269270
**optional** (boolean, `true` or `false`, default is `true`)
270271

@@ -273,7 +274,7 @@ enables or disables generation of accessor methods, i.e., getter and setter. The
273274
[NOTE]
274275
This is only used with `model-type: default`. It is ignored with `model-type: record`.
275276

276-
==== example
277+
*example*
277278

278279
Here is a small example that uses object annotation mapping to add the lombok getter and setter annotations to the generated class.
279280

@@ -359,7 +360,7 @@ selects the Jackson version, i.e., which package-name is used.
359360

360361
enables generation of JavaDoc comments from the OpenAPI `description` s on the API interfaces and model pojos.
361362

362-
=== format-code ([.badge .badge-since]+updated with 2025.1+)
363+
=== format-code
363364

364365
// [.badge .badge-since]+changed with 2025.1+
365366

@@ -385,7 +386,7 @@ In case of `google` (or `true`) see also xref:oap::jdk.adoc[JDK 16+].
385386

386387
enables generation of marker interfaces for `oneOf` objects. See xref:processor/one-of-interface.adoc#_marker_interfaces[oneOf marker interfaces].
387388

388-
=== response-interface ([.badge .badge-since]+new with 2025.2+)
389+
=== response-interface
389390

390391
**optional** (boolean, `true` or `false`, default is `false`)
391392

@@ -438,7 +439,7 @@ The other two can be used if `default` does not work.This is described in more d
438439

439440
*`framework`* does generate a slightly different enum classes than `default` and a Spring `ConverterFactory` that can deserialize incoming values to proper enum values.
440441

441-
==== example
442+
*example*
442443

443444
*mapping.yaml*
444445
[source,yaml,subs=attributes+]
@@ -512,7 +513,7 @@ this controls if the `targetDir` is the source root folder or if there is anothe
512513
| \--- model
513514
\--- resources
514515

515-
==== example
516+
*example*
516517

517518
[source,yaml,subs=attributes+]
518519
----
@@ -523,6 +524,21 @@ options:
523524
layout: standard
524525
----
525526

527+
=== spring
528+
529+
The parent key to group Spring specific options.
530+
531+
[NOTE]
532+
to benefit from editing support in IntelliJ make sure you use `openapi-processor-spring` instead of `openapi-processor-mapping` with the appropriate version.
533+
534+
==== annotations ([.badge .badge-since]+new with 2026.3+)
535+
536+
**optional** (string, `mapping` or `exchange`, default is `mapping`)
537+
538+
Select the Spring annotation family, either `mapping` for `@RequestMapping` based annotations or `exchange` for `@HttpExchange` based annotations.
539+
540+
See xref:processor/annotations.adoc[].
541+
526542
== annotation-targets: ([.badge .badge-since]+new with 2025.6+)
527543

528544
This section is used to configure the *allowed* targets of an annotation. This is like `java.lang.annotation.Target` which is used to define at which places an annotation can be used. On a type, field, method or property etc.

0 commit comments

Comments
 (0)