Skip to content

Commit 1261ab5

Browse files
committed
fixed broken links
1 parent b42d092 commit 1261ab5

1 file changed

Lines changed: 11 additions & 11 deletions

File tree

docs/modules/ROOT/pages/index.adoc

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -29,14 +29,14 @@ The interfaces will help to keep the implementation in sync with the API. If any
2929
changes in the API the interface changes and the compiler will warn that the interface is not
3030
implemented correctly.
3131

32-
See the xref:processor.adoc[processor intro] for a short example.
32+
See the xref:processor/index.adoc[processor intro] for a short example.
3333

3434

3535
== Features
3636

3737
- generates only java interfaces and java model classes (get/set POJOs) for all defined endpoints
3838
and schemas to allow full control of the endpoint implementation. It does not generate any other
39-
file. See xref:processor.adoc[processor].
39+
file. See xref:processor/index.adoc[processor].
4040

4141
- powerful type mappings with generic support (one level) to map schemas defined in the openapi.yaml
4242
to existing java types.
@@ -45,10 +45,10 @@ For example to map the openapi `array` type to a different java collections or t
4545
parameters and results to th Spring types like `Page<>` & `Pageable`.
4646
+
4747
mappings can be defined globally or for a specific response or parameter or even only for a specific
48-
endpoint. See xref:mapping.adoc[type mapping].
48+
endpoint. See xref:mapping/index.adoc[type mapping].
4949

50-
- Annotation based WebFlux support. Actually there is *no* explicit WebFlux support but the mapping
51-
allows to define *single* wrapper classes that wrap non-array result types (e.g. `Mono<>`).
50+
- Annotation based WebFlux support. Actually there is *no* explicit WebFlux support, but the mapping
51+
allows defining a *single* wrapper classes that wrap non-array result types (e.g. `Mono<>`).
5252
Together with the standard `array` mapping (e.g. `Flux<>`) there is WebFlux support. +
5353
[.badge .badge-since]+since 1.0.0.M13+
5454

@@ -58,19 +58,19 @@ Together with the standard `array` mapping (e.g. `Flux<>`) there is WebFlux supp
5858
example to pass a `HttpServletRequest` to the endpoint implementation. +
5959
[.badge .badge-since]+since 1.0.0.M6+
6060

61-
- supports bean validations. The constraints of the openapi description are mapped to java bean
61+
- supports bean validations. The constraints of the openapi description map to java bean
6262
validation annotations. +
6363
[.badge .badge-since]+since 1.0.0.M6+
6464

65-
- allows to exclude endpoints from generation. This is useful if the processor does not create the
65+
- allows excluding endpoints from generation. This is useful if the processor does not create the
6666
correct code for an endpoint. That way the processor can still be used for all the other endpoints. +
6767
[.badge .badge-since]+since 1.0.0.M6+
6868

6969
- handle multiple responses by generating one endpoint method for each response content type. +
7070
[.badge .badge-since]+since 1.0.0.M11+
7171

7272
- the generated code does not use swagger annotations. There is no need to generate the
73-
documentation from the code when the code is generated from the documentation (i.e. an openapi.yaml).
73+
documentation from the code when the code originates from the documentation (i.e. an openapi.yaml).
7474
+
7575
NOTE: The generated source code has to be included in a project to compile it. This is easily done
7676
with the link:{oap-gradle}[openapi-processor-gradle] plugin. See xref:gradle.adoc[Using Gradle].
@@ -81,7 +81,7 @@ only option to run the processor).
8181
== Releases
8282

8383
See the link:{oaps-releases}[release notes, window="_blank"] to find the latest release. The full
84-
artifact name is
84+
artifact name is:
8585

8686
.in gradle short notation
8787
----
@@ -90,11 +90,11 @@ artifact name is
9090

9191
== Feedback
9292

93-
In case some feature is missing or the generated code is not 100% what you would expect create an
93+
In case some feature is missing, or the generated code is not 100% what you would expect create an
9494
link:{oaps-issues}[issue]. Preferably with a test case. Providing a test case will help
9595
significantly :-)
9696

97-
A test case is a single folder with an `openapi.yaml` & `mapping.yaml` file and the expected Java
97+
A test case is a single folder with an `openapi.yaml` & `mapping.yaml` file, and the expected Java
9898
files the processor should create. The structure looks like this:
9999

100100
my-new-test-case/

0 commit comments

Comments
 (0)