Skip to content

Commit 0449be9

Browse files
committed
improve documentation
1 parent 91131ce commit 0449be9

File tree

4 files changed

+11
-116
lines changed

4 files changed

+11
-116
lines changed

docs/modules/ROOT/nav.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
* xref:index.adoc[Introduction]
2+
* xref:build.adoc[Build Integration]
23
* xref:processor/index.adoc[The Processor]
34
** xref:processor/configuration.adoc[Configuration]
45
** xref:processor/endpoint-interface.adoc[Endpoint Grouping]
@@ -30,5 +31,4 @@
3031
** xref:mapping/null.adoc[Null Mapping]
3132
** xref:mapping/package-name.adoc[package-name Mapping]
3233
** xref:mapping/logging.adoc[log Mapping lookup]
33-
* xref:gradle.adoc[Gradle Integration]
3434
* xref:links.adoc[Links]

docs/modules/ROOT/pages/build.adoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
include::partial$links.adoc[]
2+
:page-aliases: gradle.adoc
3+
4+
= Build Plugins
5+
6+
openapi-processor provides a xref:gradle::index.adoc[Gradle plugin] and a xref:maven::index.adoc[Maven plugin] to add openapi-processor to Gradle or Maven builds.

docs/modules/ROOT/pages/gradle.adoc

Lines changed: 0 additions & 89 deletions
This file was deleted.

docs/modules/ROOT/pages/index.adoc

Lines changed: 4 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -84,34 +84,12 @@ artifact name is:
8484

8585
== Feedback
8686

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

89-
A _perfect_ test case is a single folder with two subfolders containing the source files and the expected output files:
89+
Preferably with a test case. Providing a test case will help significantly. :-)
9090

91-
my-test-case
92-
+--- inputs.yaml
93-
|--- inputs
94-
| +--- mapping.yaml
95-
| \--- openapi.yaml
96-
+--- generated.yaml
97-
\--- generated
98-
+--- api
99-
| \--- Api.java
100-
\--- model
101-
\--- Foo.java
102-
103-
`inputs.yaml` and `generated.yaml` use the same simple format:
104-
105-
items:
106-
- inputs/openapi.yaml
107-
- inputs/mapping.yaml
108-
109-
or
110-
111-
items:
112-
- generated/api/Api.java
113-
- generated/model/Foo.java
91+
A test case contains the source files (mapping & OpenAPI) and the expected output files (generated interfaces, classes etc.).
11492

93+
See link:https://github.com/openapi-processor/openapi-processor-base/tree/main/openapi-processor-core/src/testInt/resources/tests/template[template].
11594

11695
The link:{oapc-inttests}[core project], and the link:{oaps-inttests}[spring processor] have a number of existing integration tests that can be used as examples.
117-

0 commit comments

Comments
 (0)