Skip to content

Commit 911c45e

Browse files
committed
javalinGH-203 Update wiki for 5.x branch, start 6.x on main
1 parent 624c4d3 commit 911c45e

File tree

3 files changed

+24
-9
lines changed

3 files changed

+24
-9
lines changed

.github/README.md

+22-7
Original file line numberDiff line numberDiff line change
@@ -24,12 +24,27 @@ the API looks quite the same despite some minor changes.
2424
* [Reposilite](https://github.com/dzikoysk/reposilite) - real world app using Javalin and OpenApi integration
2525

2626
### Repository structure
27-
* `openapi-annotation-processor` - compile-time annotation processor, should generate `/openapi-plugin/openapi.json` resource
28-
* `openapi-specification` - annotations & classes used to describe OpenAPI specification
29-
* `openapi-test` - example Javalin application that uses OpenApi plugin in Gradle & Maven
3027

31-
Javalin:
28+
#### Universal modules
3229

33-
* `javalin-openapi-plugin` - loads `/openapi-plugin/openapi.json` resource and serves main OpenApi endpoint
34-
* `javalin-swagger-plugin` - serves Swagger UI
35-
* `javalin-redoc-plugin` - serves ReDoc UI
30+
| Module | Description |
31+
|:-------------------------------|:-------------------------------------------------------------------------------------------|
32+
| `openapi-annotation-processor` | Compile-time annotation processor, should generate `/openapi-plugin/openapi.json` resource |
33+
| `openapi-specification` | Annotations & classes used to describe OpenAPI specification |
34+
| `openapi-test` | Example Javalin application that uses OpenApi plugin in Gradle & Maven |
35+
36+
#### Javalin plugins
37+
38+
| Plugin | Description |
39+
|:-------------------------|:-------------------------------------------------------------------------------|
40+
| `javalin-openapi-plugin` | Loads `/openapi-plugin/openapi.json` resource and serves main OpenApi endpoint |
41+
| `javalin-swagger-plugin` | Serves Swagger UI |
42+
| `javalin-redoc-plugin` | Serves ReDoc UI |
43+
44+
#### Branches
45+
46+
| Branch | Javalin version | OpenApi Version | Java Version |
47+
|:-------------------------------------------------------------|:----------------|:----------------|:-------------|
48+
| [main](https://github.com/javalin/javalin-openapi/tree/main) | 6.x | 6.x | JDK11 |
49+
| [5.x](https://github.com/javalin/javalin-openapi/tree/5.x) | 5.x | 5.x | JDK11 |
50+
| [4.x](https://github.com/javalin/javalin-openapi/tree/4.x) | 4.x | 1.x | JDK8 |

examples/javalin-maven-java/pom.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
<maven.compiler.source>11</maven.compiler.source>
1313
<maven.compiler.target>11</maven.compiler.target>
1414
<javalin.version>5.6.3</javalin.version>
15-
<javalin.openapi.version>5.6.3-2</javalin.openapi.version>
15+
<javalin.openapi.version>5.6.3-3</javalin.openapi.version>
1616
</properties>
1717

1818
<repositories>

wiki

Submodule wiki updated from 432da44 to 6170edc

0 commit comments

Comments
 (0)