Skip to content

Commit 09f88d0

Browse files
authored
Merge pull request #111 from openapi-processor/docs
Docs
2 parents 687d569 + cba9e51 commit 09f88d0

File tree

4 files changed

+6
-12
lines changed

4 files changed

+6
-12
lines changed

docs/modules/ROOT/pages/index.adoc

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
:author: Martin Hauner
22
:page-title: openapi-processor-spring
3-
:page-layout: default
43
//:page-aliases: latest@spring:ROOT:index.adoc
54
include::partial$links.adoc[]
65

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ first line of the `mapping.yaml` file.
2020
2121
[source,yaml]
2222
----
23-
openapi-processor-spring: v2
23+
openapi-processor-mapping: v2
2424
----
2525
====
2626

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ A mapping yaml looks like this:
99
[source,yaml]
1010
----
1111
options:
12-
package-name: com.github.hauner.openapi
12+
package-name: io.openapiprocessor.sample
1313
bean-validation: true
1414
1515
map:

docs/modules/ROOT/pages/processor/endpoint-interface.adoc

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
= Endpoint interface grouping
22

3-
The processor groups endpoints based on their _first_ tag. Using the `/ping` example again its first
4-
(and only) tag is **ping**:
3+
The processor groups endpoints based on their _first_ tag. Using the `/ping` example again its first (and only) tag is **ping**:
54

65
[source,yaml]
76
----
@@ -26,14 +25,10 @@ paths:
2625
type: string
2726
----
2827

29-
The interface name used for this api will be `PingApi`. `Ping` because `ping` is the tags name and
30-
`Api` is a fixed string added to `Ping`.
28+
The interface name used for this api will be `PingApi`. `Ping` because `ping` is the tags name and`Api` is a fixed string added to `Ping`.
3129

3230
In case no tags are available, all endpoints will be added to an `Api` interface.
3331

34-
The package name gets created from the configurable `packageName` parameter of the processor, and a
35-
sub package named `api`.
32+
The package name gets created from the configurable `packageName` parameter of the processor, and a sub package named `api`.
3633

37-
If the `packageName` is configured as `com.github.hauner.openapi` the final package name for the
38-
interface is `com.github.hauner.openapi.api`, and the full class & package name is
39-
`com.github.hauner.openapi.api.PingApi`.
34+
If the `packageName` is configured as `io.openapiprocessor` the final package name for the interface is `io.openapiprocessor.api`, and the full class & package name is `io.openapiprocessor.api.PingApi`.

0 commit comments

Comments
 (0)