Skip to content

Commit f2e4286

Browse files
committed
wip
1 parent 8dc891a commit f2e4286

20 files changed

+1516
-7
lines changed

docs/openapi/core_concepts/how_it_works.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,8 @@ existing code.
1414

1515
### Documentation DSL
1616

17-
The plugin provides a domain-specific language for documenting routes. The DSL is structured as nested configuration blocks:
17+
The plugin provides a domain-specific language for documenting routes. It is used to add information relevant for the OpenAPI specification
18+
to routes. The DSL is structured as nested configuration blocks:
1819

1920
```kotlin
2021
httpMethod("path", {
@@ -109,11 +110,11 @@ is generated and handled independently.
109110
````kotlin
110111
install(OpenApi) {
111112
// Base configuration applies to all specs
112-
113+
113114
spec("v1") {
114115
// Configuration specific to "v1" specification
115116
}
116-
117+
117118
spec("v2") {
118119
// Configuration specific to "v2" specification
119120
}
@@ -130,11 +131,10 @@ routing {
130131
route("api-v2.json") {
131132
openApi("v2")
132133
}
133-
134+
134135
}
135136
````
136137

137-
138138
## Plugin Lifecycle
139139

140140
**1. Route Registration**

0 commit comments

Comments
 (0)